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

Issue 834 sei models #974

Merged
merged 23 commits into from
May 6, 2020
Merged

Issue 834 sei models #974

merged 23 commits into from
May 6, 2020

Conversation

valentinsulzer
Copy link
Member

Description

Add SEI models
Just need to figure out the example (or remove?)

Fixes #834

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

@codecov
Copy link

codecov bot commented Apr 29, 2020

Codecov Report

Merging #974 into develop will increase coverage by 0.17%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #974      +/-   ##
===========================================
+ Coverage    97.48%   97.65%   +0.17%     
===========================================
  Files          222      243      +21     
  Lines        11791    12593     +802     
===========================================
+ Hits         11494    12298     +804     
+ Misses         297      295       -2     
Impacted Files Coverage Δ
...graphite_UMBL_Mohtat2020/graphite_ocp_PeymanMPM.py 100.00% <ø> (ø)
...m/models/full_battery_models/base_battery_model.py 99.59% <ø> (ø)
pybamm/parameters/parameter_sets.py 100.00% <ø> (ø)
..._UMBL_Mohtat2020/graphite_diffusivity_PeymanMPM.py 100.00% <100.00%> (ø)
...s/NMC_UMBL_Mohtat2020/NMC_diffusivity_PeymanMPM.py 100.00% <100.00%> (ø)
...ttery_models/lithium_ion/base_lithium_ion_model.py 100.00% <100.00%> (ø)
...bamm/models/full_battery_models/lithium_ion/dfn.py 100.00% <100.00%> (ø)
...bamm/models/full_battery_models/lithium_ion/spm.py 100.00% <100.00%> (ø)
...amm/models/full_battery_models/lithium_ion/spme.py 100.00% <100.00%> (ø)
pybamm/models/standard_variables.py 100.00% <100.00%> (ø)
... and 40 more

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 83fba98...2d6eb19. Read the comment docs.

Copy link
Member

@brosaplanella brosaplanella left a comment

Choose a reason for hiding this comment

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

Just a few style comments, but otherwise looks fine to me. Thanks guys!

pb.set_logging_level("INFO")
# pb.settings.debug_mode = True

options = {"sei": "reaction limited"}
Copy link
Member

Choose a reason for hiding this comment

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

Should we comment out all but one so users will know they only need one of them?

# }
# )

# parameter_values.update({"Current function [A]": 0})
Copy link
Member

Choose a reason for hiding this comment

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

If the parameter values are already in the default, I think we should delete them from here to keep it simple.

@@ -49,6 +49,11 @@ class BaseBatteryModel(pybamm.BaseModel):
variable for instead of solving in PyBaMM. The entries of the lists
are strings that correspond to the submodel names in the keys
of `self.submodels`.
* "sei" : str
Copy link
Member

Choose a reason for hiding this comment

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

We should give a reference for each model so people can check what the equations are.

@@ -36,6 +36,58 @@ def set_standard_output_variables(self):
}
)

# def set_reactions(self):
Copy link
Member

Choose a reason for hiding this comment

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

Is this needed anymore?

@valentinsulzer valentinsulzer merged commit f1c1684 into develop May 6, 2020
@valentinsulzer valentinsulzer deleted the issue-834-sei-models branch May 6, 2020 01:28
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.

Add SEI long term growth models to PyBaMM
3 participants