docs: example on battery pack [skip tests] #4596

MohammedAnsys · 2025-11-11T07:56:41Z

End-to-end PyFluent workflow on battery pack

ANSYS Fluent User's Guide, ANSYS, Inc.

Simulating a 1P3S Battery Pack Using the Battery Model

The example tries to follow the provided guidelines with #4378 and uses the new API implementation.

Thanks.

…ectrolyzers

Copilot

Pull Request Overview

This PR adds two new PyFluent example workflows demonstrating electrochemical simulations: a PEM electrolyzer model and a 1P3S battery pack simulation. Both examples follow the new API implementation guidelines and provide end-to-end workflows with visualization.

Introduces Electrolysis_Modeling_workflow.py demonstrating PEM electrolyzer simulation with Butler-Volmer kinetics
Adds Battery_Pack.py showing NTGK battery pack modeling with thermal management
Updates documentation configuration and CI workflow to include the new examples

Reviewed Changes

Copilot reviewed 4 out of 16 changed files in this pull request and generated 3 comments.

File	Description
examples/00-fluent/Electrolysis_Modeling_workflow.py	New example implementing PEM electrolysis simulation with multiphase flow and electrochemical reactions
examples/00-fluent/Battery_Pack.py	New example demonstrating 1P3S battery pack simulation with NTGK model and dual-path conductivity
doc/source/conf.py	Added new example filenames to the Sphinx gallery configuration pattern
.github/workflows/execute-examples-weekly.yml	Added execution steps for both new examples in the weekly CI workflow

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

examples/00-fluent/Battery_Pack.py

- Remove Electrolysis_Modeling_workflow.py - Remove electrolysis related PNG images - Keep only battery pack example files

Copilot

Pull Request Overview

Copilot reviewed 3 out of 11 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

examples/00-fluent/Battery_Pack.py

Co-authored-by: Copilot <[email protected]>

Copilot

Pull Request Overview

Copilot reviewed 4 out of 12 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

examples/00-fluent/battery_pack.py

Co-authored-by: Copilot <[email protected]>

Copilot

Pull Request Overview

Copilot reviewed 4 out of 12 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

prmukherj · 2025-11-11T09:19:59Z

@MohammedAnsys, please re-run the pre-commit from your end to fix the code styling issues.

MohammedAnsys · 2025-11-12T06:29:08Z

@MohammedAnsys, please re-run the pre-commit from your end to fix the code styling issues.

Done! re-ran pre-commit and fixed all styling issues.

.github/workflows/execute-examples-weekly.yml

doc/source/conf.py

examples/00-fluent/Battery_Pack.py

examples/00-fluent/battery_pack.py

examples/00-fluent/Battery_Pack.py

Co-authored-by: Abhishek Chitwar <[email protected]>

Copilot

Pull Request Overview

Copilot reviewed 4 out of 13 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Use more descriptive variable names (zone, wall instead of z, w) - Use descriptive report definition names (voltage_surface_areaavg, volume_max_temp) - Improve list comprehension formatting for better readability - Fix spelling: utlizing -> utilizing - Maintain consistent naming conventions throughout the code

Copilot

Pull Request Overview

Copilot reviewed 4 out of 13 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

examples/00-fluent/battery_pack.py

examples/00-fluent/Battery_Pack.py

Co-authored-by: Sean Pearson <[email protected]>

Copilot

Pull Request Overview

Copilot reviewed 4 out of 13 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

examples/00-fluent/battery_pack.py

seanpearsonuk · 2025-11-12T12:23:00Z

examples/00-fluent/battery_pack.py

+# Simulation of a 1P3S lithium-ion battery pack, consisting of three cells
+# connected in series and no parallel branches, undergoing a constant 200 W
+# discharge to represent a high-load condition typical in electric vehicle
+# operations such as acceleration or regenerative braking. Each cell has a


Is this described correctly? It seems to associate regenerative braking with battery discharge.

seanpearsonuk · 2025-11-12T12:24:17Z

examples/00-fluent/battery_pack.py

File name doesn't fit the naming convention.

seanpearsonuk · 2025-11-12T12:31:05Z

examples/00-fluent/battery_pack.py

+# operations such as acceleration or regenerative braking. Each cell has a
+# nominal capacity of 14.6 Ah, resulting in a total pack capacity of 14.6 Ah
+# and a nominal voltage range of 10.8–12.6 V, corresponding to an average cell
+# voltage of approximately 3.9 V. The discharge rate equates to about 1.17 C,


Omit the space in C-rate values. Otherwise, the reader could misinterpret them. To be even clearer, we might write something like "a C-rate of 1.17C" in place of "1.17 C".

Copilot

Pull Request Overview

Copilot reviewed 4 out of 13 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull Request Overview

Copilot reviewed 4 out of 13 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

seanpearsonuk · 2025-11-12T12:39:43Z

examples/00-fluent/battery_pack.py

+# -------------------------------------
+
+# Get all solid cell zones
+all_cell_zones = solver.settings.setup.cell_zone_conditions.solid.get_object_names()


CellZoneConditions has been imported

seanpearsonuk · 2025-11-12T12:40:03Z

examples/00-fluent/battery_pack.py

+all_cell_zones = solver.settings.setup.cell_zone_conditions.solid.get_object_names()
+
+# Get all wall boundaries
+all_wall_names = solver.settings.setup.boundary_conditions.wall.get_object_names()


seanpearsonuk · 2025-11-12T12:41:02Z

examples/00-fluent/battery_pack.py

+all_wall_names = solver.settings.setup.boundary_conditions.wall.get_object_names()
+
+# CELLS
+cell_zones = [zone for zone in all_cell_zones if "cell_" in zone]


Could you have used wildcard syntax to filter the names directly via the API?

seanpearsonuk · 2025-11-12T12:49:03Z

examples/00-fluent/battery_pack.py

+    save_path=os.getcwd(),
+)
+
+solver.settings.file.read_mesh(file_name=mesh_file)


Just as you can import objects, you can also import commands like ReadMesh.

seanpearsonuk · 2025-11-12T12:54:26Z

examples/00-fluent/battery_pack.py

+
+battery_model.enabled = True
+battery_model.echem_model = "ntgk/dcir"
+battery_model.eload_condition.eload_settings.eload_type = "specified-system-power"


The API design follows a peculiar hierarchy here, by prefixing with eload at three levels.

MohammedAnsys added 3 commits November 5, 2025 10:54

docs: Example on Electrolysis Modeling of Proton Exchange Membrane El…

2e77637

…ectrolyzers

Updated mode initialization to use enum

0d8d1e4

docs: Example on Battery Pack

459e0ad

MohammedAnsys requested a review from abhishekchitwar November 11, 2025 07:56

MohammedAnsys requested review from hpohekar, mayankansys, mkundu1, prmukherj and seanpearsonuk as code owners November 11, 2025 07:56

Copilot AI review requested due to automatic review settings November 11, 2025 07:56

github-actions bot added documentation Documentation related (improving, adding, etc) examples Publishing PyFluent examples maintenance General maintenance of the repo (libraries, cicd, etc) CI/CD Related to CI/CD labels Nov 11, 2025

Copilot AI reviewed Nov 11, 2025

View reviewed changes

examples/00-fluent/Battery_Pack.py Outdated Show resolved Hide resolved

examples/00-fluent/Battery_Pack.py Outdated Show resolved Hide resolved

examples/00-fluent/Battery_Pack.py Outdated Show resolved Hide resolved

fix: Remove electrolysis files from battery pack branch

5ff8c9f

- Remove Electrolysis_Modeling_workflow.py - Remove electrolysis related PNG images - Keep only battery pack example files

Copilot AI review requested due to automatic review settings November 11, 2025 08:45

MohammedAnsys force-pushed the docs/exaample_on_battery_pack branch from 200f190 to 5ff8c9f Compare November 11, 2025 08:45

Copilot AI reviewed Nov 11, 2025

View reviewed changes

examples/00-fluent/Battery_Pack.py Outdated Show resolved Hide resolved

pyansys-ci-bot and others added 2 commits November 11, 2025 08:46

chore: adding changelog file 4596.documentation.md [dependabot-skip]

a82b847

Update examples/00-fluent/Battery_Pack.py

fb8b77a

Co-authored-by: Copilot <[email protected]>

Copilot AI review requested due to automatic review settings November 11, 2025 08:47

Update examples/00-fluent/Battery_Pack.py

69f9f8c

Co-authored-by: Copilot <[email protected]>

Copilot AI reviewed Nov 11, 2025

View reviewed changes

examples/00-fluent/battery_pack.py Show resolved Hide resolved

Update examples/00-fluent/Battery_Pack.py

84b5ab9

Co-authored-by: Copilot <[email protected]>

Copilot AI review requested due to automatic review settings November 11, 2025 08:48

Copilot AI reviewed Nov 11, 2025

View reviewed changes

Merge branch 'main' into docs/exaample_on_battery_pack

64d395d

MohammedAnsys self-assigned this Nov 11, 2025

abhishekchitwar requested changes Nov 12, 2025

View reviewed changes

Update examples/00-fluent/Battery_Pack.py

681f602

Co-authored-by: Abhishek Chitwar <[email protected]>

Copilot AI review requested due to automatic review settings November 12, 2025 09:32

Update examples/00-fluent/Battery_Pack.py

40f58be

Co-authored-by: Abhishek Chitwar <[email protected]>

Copilot AI reviewed Nov 12, 2025

View reviewed changes

abhishekchitwar changed the title ~~docs: example on battery pack~~ docs: example on battery pack [skip tests] Nov 12, 2025

pyansys-ci-bot and others added 2 commits November 12, 2025 09:39

chore: adding changelog file 4596.documentation.md [dependabot-skip]

07f756c

Copilot AI review requested due to automatic review settings November 12, 2025 10:03

Copilot AI reviewed Nov 12, 2025

View reviewed changes

examples/00-fluent/battery_pack.py Show resolved Hide resolved

Merge branch 'main' into docs/exaample_on_battery_pack

cd33c42

seanpearsonuk reviewed Nov 12, 2025

View reviewed changes

examples/00-fluent/Battery_Pack.py Outdated Show resolved Hide resolved

Update examples/00-fluent/Battery_Pack.py

86d66ca

Co-authored-by: Sean Pearson <[email protected]>

Copilot AI review requested due to automatic review settings November 12, 2025 12:14

Copilot AI reviewed Nov 12, 2025

View reviewed changes

examples/00-fluent/battery_pack.py Show resolved Hide resolved

Merge branch 'main' into docs/exaample_on_battery_pack

026c348

MohammedAnsys requested a review from abhishekchitwar November 12, 2025 12:22

rename files to follow lowercase naming convention

bc60667

Copilot AI review requested due to automatic review settings November 12, 2025 12:32

seanpearsonuk reviewed Nov 12, 2025

View reviewed changes

Copilot AI reviewed Nov 12, 2025

View reviewed changes

Rename Battery_Pack.py to battery_pack.py

ad643d3

Copilot AI review requested due to automatic review settings November 12, 2025 12:35

Copilot AI reviewed Nov 12, 2025

View reviewed changes

seanpearsonuk reviewed Nov 12, 2025

View reviewed changes

docs: example on battery pack [skip tests] #4596

Are you sure you want to change the base?

docs: example on battery pack [skip tests] #4596

Uh oh!

Conversation

MohammedAnsys commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

prmukherj commented Nov 11, 2025

Uh oh!

MohammedAnsys commented Nov 12, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MohammedAnsys commented Nov 11, 2025 •

edited

Loading