Add constant symbol for named constants #5070
Merged
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #5070 +/- ##
========================================
Coverage 98.58% 98.58%
========================================
Files 304 304
Lines 23731 23740 +9
========================================
+ Hits 23395 23404 +9
Misses 336 336 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
martinjrobins
requested changes
Jun 20, 2025
There was a problem hiding this comment.
thanks @rtimms, this looks very useful. Presumably these nodes should be replaced by scalars during discretisation, so that they are then simplified? Is this the desired behaviour? If so I think adding a test to make sure this happens would be good.
|
Yes, good point, I think this is what happens since they get simplified on evaluation, but I'll add a test to confirm this behaviour |
rtimms
commented
Jun 20, 2025
rtimms
commented
Jun 20, 2025
martinjrobins
previously approved these changes
Jun 22, 2025
martinjrobins
approved these changes
Jun 22, 2025
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
Adds a new
Constantsymbol for named constants. This is a subclass ofpybamm.Scalarand is used to represent named constants such as the gas constant. This avoids constants being simplified out when printing expressions (but they are still simplified when evaluated). For example,pybamm.constants.R + 2should print2+Rand evaluate to10.314462618. Counterintuitively, the "is_constant" method is set to False, so that named constants are not simplified when constructed. This is maybe a little confusing, but this is the cleanest way of avoiding simplifications without checking for instances ofConstanteverywhere.Fixes # (issue)
Type of change
Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #)
Important checks:
Please confirm the following before marking the PR as ready for review:
nox -s pre-commitnox -s testsnox -s doctests