Merge pull request #1686 from pybamm-team/issue-1685-lam

Issue 1685 lam

Author: valentinsulzer

examples/notebooks/models/submodel_loss_of_active_materials.ipynb

@@ -47,6 +47,6 @@ Negative electrode cracking rate,[function]graphite_cracking_rate_Ai2020,,
 Negative electrode activation energy for cracking rate [J.mol-1],0,,
 ,,,
 # Loss of active materials (LAM) model,,,
-Negative electrode LAM constant propotional term,0,,
+Negative electrode LAM constant proportional term [s-1],0,,
 Negative electrode LAM constant exponential term,2,,
 Negative electrode critical stress [Pa],60e6,, 

pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_Ai2020/parameters.csv

@@ -48,6 +48,6 @@ Positive electrode cracking rate,[function]lico2_cracking_rate_Ai2020,,
 Positive electrode activation energy for cracking rate [J.mol-1],0,,
 ,,,
 # Loss of active materials (LAM) model,,,
-Positive electrode LAM constant propotional term,1e-9,,
+Positive electrode LAM constant proportional term [s-1],2.78e-13,,
 Positive electrode LAM constant exponential term,2,,
 Positive electrode critical stress [Pa],375e6,, 

pybamm/input/parameters/lithium_ion/positive_electrodes/lico2_Ai2020/parameters.csv

@@ -88,8 +88,7 @@ def get_coupled_variables(self, variables):
         # assuming the minimum hydrostatic stress is zero for full cycles
         stress_h_surf_min = stress_h_surf * 0
         j_stress_LAM = (
-            -(beta_LAM / self.param.t0_cr)
-            * ((stress_h_surf - stress_h_surf_min) / stress_critical) ** m_LAM
+            -beta_LAM * ((stress_h_surf - stress_h_surf_min) / stress_critical) ** m_LAM
         )
 
         deps_solid_dt = j_stress_LAM

pybamm/models/submodels/active_material/stress_driven_active_material.py

@@ -334,17 +334,17 @@ def _set_dimensional_parameters(self):
         self.m_LAM_n = pybamm.Parameter(
             "Negative electrode LAM constant exponential term"
         )
-        self.beta_LAM_n = pybamm.Parameter(
-            "Negative electrode LAM constant propotional term"
+        self.beta_LAM_n_dimensional = pybamm.Parameter(
+            "Negative electrode LAM constant proportional term [s-1]"
         )
         self.stress_critical_n_dim = pybamm.Parameter(
             "Negative electrode critical stress [Pa]"
         )
         self.m_LAM_p = pybamm.Parameter(
             "Positive electrode LAM constant exponential term"
         )
-        self.beta_LAM_p = pybamm.Parameter(
-            "Positive electrode LAM constant propotional term"
+        self.beta_LAM_p_dimensional = pybamm.Parameter(
+            "Positive electrode LAM constant proportional term [s-1]"
         )
         self.stress_critical_p_dim = pybamm.Parameter(
             "Positive electrode critical stress [Pa]"
@@ -859,6 +859,8 @@ def _set_dimensionless_parameters(self):
         self.c_p_0 = self.c_p_0_dim / self.c_p_max
         self.c_n_0 = self.c_n_0_dim / self.c_n_max
         self.t0_cr = 3600 / self.C_rate / self.timescale
+        self.beta_LAM_n = self.beta_LAM_n_dimensional * self.timescale
+        self.beta_LAM_p = self.beta_LAM_p_dimensional * self.timescale
         # normalised typical time for one cycle
         self.stress_critical_n = self.stress_critical_n_dim / self.E_n
         self.stress_critical_p = self.stress_critical_p_dim / self.E_p

pybamm/parameters/lithium_ion_parameters.py

@@ -373,26 +373,30 @@ def check_parameter_values(self, values):
                     "Parameters involving 'surface area density' have been renamed to "
                     "'surface area to volume ratio' ('{}' found)".format(param)
                 )
-            if "reaction rate" in param:
+            elif "reaction rate" in param:
                 raise ValueError(
                     "Parameters involving 'reaction rate' have been replaced with "
                     "'exchange-current density' ('{}' found)".format(param)
                 )
-        for param in values:
-            if "particle distribution in x" in param:
+            elif "particle distribution in x" in param:
                 raise ValueError(
                     "The parameter '{}' has been deprecated".format(param)
                     + "The particle radius is now set as a function of x directly "
                     "instead of providing a reference value and a distribution."
                 )
-        for param in values:
-            if "surface area to volume ratio distribution in x" in param:
+            elif "surface area to volume ratio distribution in x" in param:
                 raise ValueError(
                     "The parameter '{}' has been deprecated".format(param)
                     + "The surface area to volume ratio is now set as a function "
                     "of x directly instead of providing a reference value and a "
                     "distribution."
                 )
+            elif "propotional term" in param:
+                raise ValueError(
+                    f"The parameter '{param}' has been renamed to "
+                    "'... proportional term [s-1]', and its value should now be divided"
+                    "by 3600 to get the same results as before."
+                )
 
     def process_model(self, unprocessed_model, inplace=True):
         """Assign parameter values to a model.

pybamm/parameters/parameter_values.py

@@ -137,6 +137,10 @@ def test_check_parameter_values(self):
             pybamm.ParameterValues(
                 {"Negative electrode surface area to volume ratio distribution in x": 1}
             )
+        with self.assertRaisesRegex(ValueError, "propotional term"):
+            pybamm.ParameterValues(
+                {"Negative electrode LAM constant propotional term": 1}
+            )
 
     def test_process_symbol(self):
         parameter_values = pybamm.ParameterValues({"a": 4, "b": 2, "c": 3})
@@ -585,7 +589,7 @@ def test_process_integral_broadcast(self):
             auxiliary_domains={
                 "secondary": "test sec",
                 "tertiary": "test tert",
-                "quaternary": "test quat"
+                "quaternary": "test quat",
             },
         )
         func = pybamm.x_average(pybamm.FunctionParameter("func", {"var": var}))
@@ -598,7 +602,7 @@ def test_process_integral_broadcast(self):
             pybamm.FullBroadcast(
                 pybamm.Scalar(2, name="func"),
                 "test sec",
-                {"secondary": "test tert", "tertiary": "test quat"}
+                {"secondary": "test tert", "tertiary": "test quat"},
             ).id,
         )