Skip to content

Fix default 'surface form' option for explicitly specified single-pha… #5684

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.

Sign up for GitHub

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

Open
AIMindCrafter wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix default 'surface form' option for explicitly specified single-pha… #5684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/pybamm/src/pybamm/models/full_battery_models/base_battery_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,7 @@ def __init__(self, extra_options):
# phases option is provided.
# return "1" if option not given
phases_option = extra_options.get("particle phases", "1")
if phases_option == "1":
if phases_option in ["1", ("1", "1"), ["1", "1"]]:
default_options["surface form"] = "false"
else:
default_options["surface form"] = "algebraic"
Expand Down Expand Up @@ -703,7 +703,7 @@ def __init__(self, extra_options):
# then "total interfacial current density as a state" must be "true"
if (
options["SEI film resistance"] != "none"
and options["particle phases"] != "1"
and options["particle phases"] not in ["1", ("1", "1"), ["1", "1"]]
):
options["total interfacial current density as a state"] = "true"
# Check that extra_options did not try to provide a clashing option
Expand Down Expand Up @@ -849,7 +849,7 @@ def __init__(self, extra_options):
"current collectors in a half-cell configuration"
)

if options["particle phases"] not in ["1", ("1", "1")]:
if options["particle phases"] not in ["1", ("1", "1"), ["1", "1"]]:
if not (
options["surface form"] != "false"
and options["particle"] == "Fickian diffusion"
Expand Down
2 changes: 1 addition & 1 deletion packages/pybamm/src/pybamm/models/full_battery_models/lithium_ion/base_lithium_ion_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ def default_quick_plot_variables(self):
def calc_esoh(self):
"""Whether to include eSOH variables in the summary variables."""
if (
self.options["particle phases"] not in ["1", ("1", "1")]
self.options["particle phases"] not in ["1", ("1", "1"), ["1", "1"]]
or self.options["working electrode"] != "both"
):
self._calc_esoh = False
Expand Down
8 changes: 8 additions & 0 deletions packages/pybamm/tests/unit/test_models/test_full_battery_models/test_base_battery_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -697,6 +697,14 @@ def test_default_options_cover_all_possible_options(self):
for key in options.possible_options:
assert key in options, f"Missing default for option '{key}'"

def test_explicit_single_phase_surface_form(self):
"""Explicit single-phase specification ("1", "1") should default surface form to false."""
options_default = BatteryModelOptions({})
assert options_default["surface form"] == "false"

options_explicit_tuple = BatteryModelOptions({"particle phases": ("1", "1")})
assert options_explicit_tuple["surface form"] == "false"


class TestVaasNormalization:
"""Test the centralized VAAS + surface form policy."""
Expand Down