Change heat generation units and name#12
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aligns the PyBaMM cell blocks’ heat-generation output with the lumped thermal model by (1) standardizing the port name to Q_dot and (2) switching the reported quantity to total heat generation in Watts.
Changes:
- Renamed cell heat output port from
Q_heattoQ_dotacross blocks and tests. - Switched PyBaMM output variable from volumetric heating (
... [W.m-3]) to total heating (... [W]) and updated docstrings accordingly.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
src/pathsim_batt/cells/pybamm_cell.py |
Renames heat output port to Q_dot and changes heat output variable/units to total heating in W. |
tests/cells/test_pybamm_cell.py |
Updates tests to expect Q_dot instead of Q_heat in labels, comments, and assertions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
When creating a sim in PathView, I noticed two inconsistencies in the output of cell vs the input of the lumped thermal model block:
Q_heatas output port name, the thermal modelQ_dotas inputBoth are named
Q_dotnow and are in Watts.