Revision of the hysteresis notebook to include the method implemented in the module axen_ocp #4880
+82
−19
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
385de0a to
0e19485
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #4880 +/- ##
========================================
Coverage 98.70% 98.71%
========================================
Files 304 304
Lines 23482 23495 +13
========================================
+ Hits 23179 23192 +13
Misses 303 303 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
0e19485 to
2b9865a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR is an extension of PR #4816, where an empirical method was proposed to handle hysteresis in the open-circuit potential.
This method is similar to the Wycisk approach, but it skips the need of calculating the differentiation
dU = self.phase_param.U(sto_surf, T_bulk).diff(sto_surf), and defines separate decay rates for lithiation and delithiation.The method is activated by passing the keyword "Axen" to the model option "open-circuit potential".
Fixes #4851
Type of change
This PR updates the notebook docs/source/examples/notebooks/models/differential-capacity-hysteresis-state.ipynb to show the features of a newly implemented hysteresis method, comparing it to the current-sigmoid and Wycisk's methods.
A brief explanation of the method is added to the notebook together with an example simulation.
The relevant section of the CHANGELOG.md file has also been updated to reflect the change.
Important checks:
Please confirm the following before marking the PR as ready for review:
nox -s pre-commitnox -s testsnox -s doctests