Skip to content

3D Thermal Model #5112

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

Merged
merged 37 commits into from
Jul 22, 2025
Merged

3D Thermal Model #5112

merged 37 commits into from
Jul 22, 2025

Conversation

Rishab87
Copy link
Contributor

@Rishab87 Rishab87 commented Jul 12, 2025

Description

Added a Basic3DThermalSPM model with two way coupling.

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:

  • No style issues: nox -s pre-commit
  • All tests pass: nox -s tests
  • The documentation builds: nox -s doctests
  • Code is commented for hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@Rishab87 Rishab87 requested a review from a team as a code owner July 12, 2025 08:46
@Rishab87
Copy link
Contributor Author

Rishab87 commented Jul 12, 2025

@rtimms can you review this? (also run the CI wanted to see coverage)

Copy link

codecov bot commented Jul 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.12%. Comparing base (1e85897) to head (4cfe489).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff            @@
##           develop    #5112    +/-   ##
=========================================
  Coverage    99.12%   99.12%            
=========================================
  Files          309      310     +1     
  Lines        24136    24313   +177     
=========================================
+ Hits         23924    24101   +177     
  Misses         212      212            

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Rishab87
Copy link
Contributor Author

@rtimms , I've addressed the reviews and coverage in unit tests. Can you please re-review it?

@Rishab87 Rishab87 requested a review from rtimms July 14, 2025 14:34
@agriyakhetarpal agriyakhetarpal added the GSoC 2025 Items being done as part of GSoC 2025 label Jul 21, 2025
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, looks great! just a few small changes

@@ -30,6 +30,8 @@ def battery_geometry(
"""
if options is None or type(options) == dict: # noqa: E721
options = pybamm.BatteryModelOptions(options)
if options["cell geometry"] == "cylindrical":
Copy link
Contributor

Choose a reason for hiding this comment

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

Since form_factor is a kwarg of this method, I don't think we should update it in this way. Instead, we should catch it earlier and explicitly pass form_factor to battery_geometry

Rishab87 and others added 6 commits July 21, 2025 14:45
Co-authored-by: Robert Timms <43040151+rtimms@users.noreply.github.com>
Co-authored-by: Robert Timms <43040151+rtimms@users.noreply.github.com>
Co-authored-by: Robert Timms <43040151+rtimms@users.noreply.github.com>
@Rishab87 Rishab87 requested a review from rtimms July 21, 2025 12:57
@Rishab87
Copy link
Contributor Author

@rtimms I've addressed all reviews, can you please re-review it?

rtimms
rtimms previously approved these changes Jul 21, 2025
@Rishab87 Rishab87 changed the title [GSOC 2025] 3D Thermal Model 3D Thermal Model Jul 21, 2025
@rtimms rtimms enabled auto-merge (squash) July 21, 2025 19:58
@rtimms rtimms merged commit 6dc2a9b into pybamm-team:develop Jul 22, 2025
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GSoC 2025 Items being done as part of GSoC 2025
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants