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 1781 utilization #1821

Merged
merged 20 commits into from
Nov 30, 2021
Merged

Issue 1781 utilization #1821

merged 20 commits into from
Nov 30, 2021

Conversation

valentinsulzer
Copy link
Member

Description

  • Remove the "user" option for particle shape. Particle shape is now determined by geometry
  • Add "utilisation" submodels

Fixes #1781

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 Nov 23, 2021

Codecov Report

Merging #1821 (2cbd04f) into develop (051896e) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##           develop    #1821    +/-   ##
=========================================
  Coverage    99.25%   99.26%            
=========================================
  Files          340      345     +5     
  Lines        18773    18900   +127     
=========================================
+ Hits         18634    18761   +127     
  Misses         139      139            
Impacted Files Coverage Δ
.../submodels/active_material/base_active_material.py 100.00% <ø> (ø)
...ybamm/models/submodels/interface/sei/sei_growth.py 100.00% <ø> (ø)
pybamm/__init__.py 94.82% <100.00%> (+0.04%) ⬆️
...m/models/full_battery_models/base_battery_model.py 99.73% <100.00%> (+0.01%) ⬆️
...ybamm/models/full_battery_models/lead_acid/full.py 100.00% <100.00%> (ø)
...dels/full_battery_models/lead_acid/higher_order.py 98.13% <100.00%> (+0.01%) ⬆️
...ybamm/models/full_battery_models/lead_acid/loqs.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%> (ø)
... and 14 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 051896e...2cbd04f. Read the comment docs.

Copy link
Sponsor 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.

Looks good, just some small comments.

@@ -3,7 +3,7 @@
#
import pybamm

pybamm.set_logging_level("INFO")
pybamm.set_logging_level("DEBUG")
Copy link
Sponsor Member

Choose a reason for hiding this comment

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

Should we set it back to INFO?

@@ -20,4 +20,6 @@
sims.append(sim)

# plot
pybamm.dynamic_plot(sims)
pybamm.dynamic_plot(
Copy link
Sponsor Member

Choose a reason for hiding this comment

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

Should we revert it?

def test_constant_utilisation(self):
options = {"interface utilisation": "constant"}
parameter_values = pybamm.ParameterValues(
chemistry=pybamm.parameter_sets.Marquis2019
Copy link
Sponsor Member

Choose a reason for hiding this comment

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

Hasn't the keyword argument been deprecated?

@valentinsulzer valentinsulzer merged commit 2cbd04f into develop Nov 30, 2021
@valentinsulzer valentinsulzer deleted the issue-1781-utilization branch November 30, 2021 16:53
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.

Scaling of interfacial currents with particle shape
2 participants