Fixes breaking changes from pybamm-team#3624 (pybamm-team#4072)

* removes breaking change from electrode diffusivity -> particle diffusivity * Add conditional entry for base_solver inputs recreation * fix: incorrect depreciated parameter translation, moves conversion to ParameterValues staticmethod Fixes an incorrect conversion of electrode diffusivity to particle diffusivity, Updates the corresponding test to ensure FuzzyDict.__getitem__ functions correctly, Adds conversion and checks to BaseSolver inputs object, * Add changelog entry --------- Co-authored-by: Eric G. Kratz <[email protected]>
js1tr3 · Aug 12, 2024 · c5012ba · c5012ba
1 parent 9f5afbe
commit c5012ba
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 11 deletions.
diff --git a/pybamm/parameters/parameter_values.py b/pybamm/parameters/parameter_values.py
@@ -5,6 +5,7 @@
 import pybamm
 import numbers
 from pprint import pformat
+from warnings import warn
 from collections import defaultdict
 
 
@@ -229,7 +230,7 @@ def update(self, values, check_conflict=False, check_already_exists=True, path="
         if not isinstance(values, dict):
             values = values._dict_items
         # check parameter values
-        self.check_parameter_values(values)
+        values = self.check_parameter_values(values)
         # update
         for name, value in values.items():
             # check for conflicts
@@ -389,7 +390,8 @@ def set_initial_ocps(
         )
         return parameter_values
 
-    def check_parameter_values(self, values):
+    @staticmethod
+    def check_parameter_values(values):
         for param in values:
             if "propotional term" in param:
                 raise ValueError(
@@ -402,6 +404,15 @@ def check_parameter_values(self, values):
                 raise ValueError(
                     f"parameter '{param}' has been renamed to " "'Thermodynamic factor'"
                 )
+            if "electrode diffusivity" in param:
+                warn(
+                    f"The parameter '{param}' has been renamed to '{param.replace('electrode', 'particle')}'",
+                    DeprecationWarning,
+                    stacklevel=2,
+                )
+                param = param.replace("electrode", "particle")
+
+        return values
 
     def process_model(self, unprocessed_model, inplace=True):
         """Assign parameter values to a model.

diff --git a/pybamm/solvers/base_solver.py b/pybamm/solvers/base_solver.py
@@ -12,6 +12,7 @@
 
 import pybamm
 from pybamm.expression_tree.binary_operators import _Heaviside
+from pybamm import ParameterValues
 
 
 class BaseSolver:
@@ -1401,7 +1402,10 @@ def get_platform_context(self, system_type: str):
     @staticmethod
     def _set_up_model_inputs(model, inputs):
         """Set up input parameters"""
-        inputs = inputs or {}
+        if inputs is None:
+            inputs = {}
+        else:
+            inputs = ParameterValues.check_parameter_values(inputs)
 
         # Go through all input parameters that can be found in the model
         # Only keep the ones that are actually used in the model

diff --git a/pybamm/util.py b/pybamm/util.py
@@ -59,14 +59,14 @@ def __getitem__(self, key):
         try:
             return super().__getitem__(key)
         except KeyError as error:
-            if "particle diffusivity" in key:
+            if "electrode diffusivity" in key:
                 warn(
-                    f"The parameter '{key.replace('particle', 'electrode')}' "
+                    f"The parameter '{key.replace('electrode', 'particle')}' "
                     f"has been renamed to '{key}'",
                     DeprecationWarning,
                     stacklevel=2,
                 )
-                return super().__getitem__(key.replace("particle", "electrode"))
+                return super().__getitem__(key.replace("electrode", "particle"))
             if key in ["Negative electrode SOC", "Positive electrode SOC"]:
                 domain = key.split(" ")[0]
                 raise KeyError(

diff --git a/tests/unit/test_util.py b/tests/unit/test_util.py
@@ -36,7 +36,7 @@ def test_fuzzy_dict(self):
                 "SEI current": 3,
                 "Lithium plating current": 4,
                 "A dimensional variable [m]": 5,
-                "Positive electrode diffusivity [m2.s-1]": 6,
+                "Positive particle diffusivity [m2.s-1]": 6,
             }
         )
         self.assertEqual(d["test"], 1)
@@ -59,10 +59,7 @@ def test_fuzzy_dict(self):
             d.__getitem__("Open-circuit voltage at 100% SOC [V]")
 
         with self.assertWarns(DeprecationWarning):
-            self.assertEqual(
-                d["Positive electrode diffusivity [m2.s-1]"],
-                d["Positive particle diffusivity [m2.s-1]"],
-            )
+            self.assertEqual(d["Positive electrode diffusivity [m2.s-1]"], 6)
 
     def test_get_parameters_filepath(self):
         tempfile_obj = tempfile.NamedTemporaryFile("w", dir=".")