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

fix bug in composite surface form model #4293

Merged
merged 1 commit into from
Jul 25, 2024
Merged

Conversation

rtimms
Copy link
Contributor

@rtimms rtimms commented Jul 25, 2024

Description

Fixes a bug where a factor of electrode surface area to volume ratio is missing in the rhs of the CompositeDifferential conductivity model.

In particular, this fixes the missing semi-circle when simulating EIS with SPMe. This got missed in #4139

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: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python run-tests.py --all (or $ nox -s tests)
  • The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ nox -s quick).

Further checks:

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

@rtimms
Copy link
Contributor Author

rtimms commented Jul 25, 2024

@kratman @Saransh-cpp can we squeeze this bug fix into 24.5 or if it's simpler do a patch?

Copy link

codecov bot commented Jul 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.45%. Comparing base (ba39170) to head (a5f7bb0).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4293   +/-   ##
========================================
  Coverage    99.45%   99.45%           
========================================
  Files          288      288           
  Lines        22091    22092    +1     
========================================
+ Hits         21971    21972    +1     
  Misses         120      120           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kratman
Copy link
Contributor

kratman commented Jul 25, 2024

I will cherry-pick this into the release

@kratman kratman mentioned this pull request Jul 25, 2024
@kratman kratman merged commit 91c9744 into develop Jul 25, 2024
25 checks passed
@kratman kratman deleted the composite-surface-bug branch July 25, 2024 22:30
js1tr3 pushed a commit to js1tr3/PyBaMM that referenced this pull request Aug 12, 2024
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.

3 participants