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

Geometric input params #4665

Merged
merged 22 commits into from
Jan 2, 2025
Merged

Conversation

aabills
Copy link
Contributor

@aabills aabills commented Dec 11, 2024

Description

This pull request implements a SymbolicUniform1DSubmesh, which allows for geometric parameters, such as electrode thicknesses and particle sizes to be pybamm.InputParameter's.

Fixes #3649

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 -m pytest (or $ nox -s tests)
  • The documentation builds: $ python -m pytest --doctest-plus src (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ 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

Copy link

codecov bot commented Dec 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.25%. Comparing base (a7253b8) to head (b46abfc).
Report is 17 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4665      +/-   ##
===========================================
+ Coverage    99.22%   99.25%   +0.02%     
===========================================
  Files          303      303              
  Lines        23070    23223     +153     
===========================================
+ Hits         22891    23049     +158     
+ Misses         179      174       -5     

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

@aabills aabills marked this pull request as ready for review December 31, 2024 20:55
@aabills aabills added the release blocker Issues that need to be addressed before the creation of a release label Jan 1, 2025
@aabills aabills enabled auto-merge (squash) January 2, 2025 00:17
Copy link
Contributor

@rtimms rtimms left a comment

Choose a reason for hiding this comment

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

thanks @aabills looks great, just a few comments

@aabills aabills mentioned this pull request Jan 2, 2025
8 tasks
@aabills aabills requested a review from rtimms January 2, 2025 17:46
@aabills aabills merged commit 006f3c5 into pybamm-team:develop Jan 2, 2025
26 checks passed
@brosaplanella
Copy link
Member

Sorry, got late to the review, but that's great! Tagging @BradyPlanden as this will be relevant to PyBOP.

@aabills
Copy link
Contributor Author

aabills commented Jan 3, 2025

Do reach out to me if you are interested in using it, it doesn't work with the "out of the box" pybamm models but its relatively straightforward to get it working with custom models

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release blocker Issues that need to be addressed before the creation of a release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Geometry parameters must be Scalars after parameter processing
4 participants