Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#1343 update get_termination_reason to return solution #1344

Merged
merged 4 commits into from
Jan 26, 2021

Conversation

rtimms
Copy link
Contributor

@rtimms rtimms commented Jan 25, 2021

Description

Return the solution as well as the termination reason in get_termination_reason. This is so that the updated solution (solution = solution + event_sol) which includes the event state gets returned by the solver.

Fixes #1343

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ flake8
  • All tests pass: $ python run-tests.py --unit
  • The documentation builds: $ cd docs and then $ make clean; make html

You can run all three at once, using $ python run-tests.py --quick.

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

Copy link
Member

@valentinsulzer valentinsulzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh that makes sense, thanks for fixing

# to a different event - this isn't captured here (or in the logger info)
solutions[0], termination = self.get_termination_reason(
solutions[0], model.events
)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't this a trivial for loop?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I’ll add it. For the logger info shall i just give different info when it’s a list of inputs (ie don’t specify a termination reason since it may be different for each solution).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah sounds good

@codecov
Copy link

codecov bot commented Jan 26, 2021

Codecov Report

Merging #1344 (8d5f8d0) into develop (57ab11d) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1344   +/-   ##
========================================
  Coverage    98.14%   98.14%           
========================================
  Files          272      272           
  Lines        15561    15566    +5     
========================================
+ Hits         15273    15278    +5     
  Misses         288      288           
Impacted Files Coverage Δ
pybamm/solvers/base_solver.py 99.13% <100.00%> (+<0.01%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 57ab11d...8d5f8d0. Read the comment docs.

@rtimms rtimms merged commit b1b9b2f into develop Jan 26, 2021
@rtimms rtimms deleted the issue-1343-event-state-bug branch January 26, 2021 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Event time and state missing from solution
2 participants