#1489 add surface area to volume ratio factor

pybamm-team · Nov 9, 2021 · e88fd31 · e88fd31
1 parent dd77bec
commit e88fd31
Show file tree

Hide file tree

Showing 9 changed files with 51 additions and 18 deletions.
diff --git a/examples/scripts/compare_lithium_ion.py b/examples/scripts/compare_lithium_ion.py
@@ -7,10 +7,10 @@
 
 # load models
 models = [
-    pybamm.lithium_ion.SPM(),
-    pybamm.lithium_ion.SPMe(),
+    # pybamm.lithium_ion.SPM(),
+    # pybamm.lithium_ion.SPMe(),
     pybamm.lithium_ion.DFN(),
-    pybamm.lithium_ion.NewmanTobias(),
+    # pybamm.lithium_ion.NewmanTobias(),
 ]
 
 # create and run simulations
@@ -21,4 +21,4 @@
     sims.append(sim)
 
 # plot
-pybamm.dynamic_plot(sims)
+pybamm.dynamic_plot(sims, ["Negative electrode surface area to volume ratio"])
diff --git a/pybamm/models/submodels/interface/lithium_plating/irreversible_plating.py b/pybamm/models/submodels/interface/lithium_plating/irreversible_plating.py
@@ -77,12 +77,15 @@ def set_rhs(self, variables):
             j_stripping = variables[
                 "X-averaged lithium plating interfacial current density"
             ]
+            a = variables["X-averaged negative electrode surface area to volume ratio"]
         else:
             c_plated_Li = variables["Lithium plating concentration"]
             j_stripping = variables["Lithium plating interfacial current density"]
+            a = variables["Negative electrode surface area to volume ratio"]
 
         Gamma_plating = self.param.Gamma_plating
-        self.rhs = {c_plated_Li: -Gamma_plating * j_stripping}
+
+        self.rhs = {c_plated_Li: -Gamma_plating * a * j_stripping}
 
     def set_initial_conditions(self, variables):
         if self.x_average is True:

diff --git a/pybamm/models/submodels/interface/lithium_plating/reversible_plating.py b/pybamm/models/submodels/interface/lithium_plating/reversible_plating.py
@@ -77,12 +77,15 @@ def set_rhs(self, variables):
             j_stripping = variables[
                 "X-averaged lithium plating interfacial current density"
             ]
+            a = variables["X-averaged negative electrode surface area to volume ratio"]
         else:
             c_plated_Li = variables["Lithium plating concentration"]
             j_stripping = variables["Lithium plating interfacial current density"]
+            a = variables["Negative electrode surface area to volume ratio"]
 
         Gamma_plating = self.param.Gamma_plating
-        self.rhs = {c_plated_Li: -Gamma_plating * j_stripping}
+
+        self.rhs = {c_plated_Li: -Gamma_plating * a * j_stripping}
 
     def set_initial_conditions(self, variables):
         if self.x_average is True:

diff --git a/pybamm/models/submodels/interface/sei/ec_reaction_limited.py b/pybamm/models/submodels/interface/sei/ec_reaction_limited.py
@@ -123,9 +123,14 @@ def set_rhs(self, variables):
             L_sei = variables["Outer SEI thickness"]
             j_sei = variables["Outer SEI interfacial current density"]
 
+        if self.reaction_loc == "interface":
+            a = 1
+        else:
+            a = variables["Negative electrode surface area to volume ratio"]
+
         Gamma_SEI = self.param.Gamma_SEI
 
-        self.rhs = {L_sei: -Gamma_SEI * j_sei / 2}
+        self.rhs = {L_sei: -Gamma_SEI * a * j_sei / 2}
 
     def set_initial_conditions(self, variables):
         if self.reaction_loc == "x-average":

diff --git a/pybamm/models/submodels/interface/sei/electron_migration_limited.py b/pybamm/models/submodels/interface/sei/electron_migration_limited.py
@@ -79,12 +79,17 @@ def set_rhs(self, variables):
             j_inner = variables["Inner SEI interfacial current density"]
             j_outer = variables["Outer SEI interfacial current density"]
 
+        if self.reaction_loc == "interface":
+            a = 1
+        else:
+            a = variables["Negative electrode surface area to volume ratio"]
+
         v_bar = self.param.v_bar
         Gamma_SEI = self.param.Gamma_SEI
 
         self.rhs = {
-            L_inner: -Gamma_SEI * j_inner,
-            L_outer: -v_bar * Gamma_SEI * j_outer,
+            L_inner: -Gamma_SEI * a * j_inner,
+            L_outer: -v_bar * Gamma_SEI * a * j_outer,
         }
 
     def set_initial_conditions(self, variables):

diff --git a/pybamm/models/submodels/interface/sei/interstitial_diffusion_limited.py b/pybamm/models/submodels/interface/sei/interstitial_diffusion_limited.py
@@ -81,13 +81,17 @@ def set_rhs(self, variables):
             j_inner = variables["Inner SEI interfacial current density"]
             j_outer = variables["Outer SEI interfacial current density"]
 
-        v_bar = self.param.v_bar
+        if self.reaction_loc == "interface":
+            a = 1
+        else:
+            a = variables["Negative electrode surface area to volume ratio"]
 
+        v_bar = self.param.v_bar
         Gamma_SEI = self.param.Gamma_SEI
 
         self.rhs = {
-            L_inner: -Gamma_SEI * j_inner,
-            L_outer: -v_bar * Gamma_SEI * j_outer,
+            L_inner: -Gamma_SEI * a * j_inner,
+            L_outer: -v_bar * Gamma_SEI * a * j_outer,
         }
 
     def set_initial_conditions(self, variables):

diff --git a/pybamm/models/submodels/interface/sei/reaction_limited.py b/pybamm/models/submodels/interface/sei/reaction_limited.py
@@ -101,12 +101,17 @@ def set_rhs(self, variables):
             j_inner = variables["Inner SEI interfacial current density"]
             j_outer = variables["Outer SEI interfacial current density"]
 
+        if self.reaction_loc == "interface":
+            a = 1
+        else:
+            a = variables["Negative electrode surface area to volume ratio"]
+
         v_bar = self.param.v_bar
         Gamma_SEI = self.param.Gamma_SEI
 
         self.rhs = {
-            L_inner: -Gamma_SEI * j_inner,
-            L_outer: -v_bar * Gamma_SEI * j_outer,
+            L_inner: -Gamma_SEI * a * j_inner,
+            L_outer: -v_bar * Gamma_SEI * a * j_outer,
         }
 
     def set_initial_conditions(self, variables):

diff --git a/pybamm/models/submodels/interface/sei/solvent_diffusion_limited.py b/pybamm/models/submodels/interface/sei/solvent_diffusion_limited.py
@@ -73,13 +73,18 @@ def set_rhs(self, variables):
             L_outer = variables["Outer SEI thickness"]
             j_inner = variables["Inner SEI interfacial current density"]
             j_outer = variables["Outer SEI interfacial current density"]
-        v_bar = self.param.v_bar
 
+        if self.reaction_loc == "interface":
+            a = 1
+        else:
+            a = variables["Negative electrode surface area to volume ratio"]
+
+        v_bar = self.param.v_bar
         Gamma_SEI = self.param.Gamma_SEI
 
         self.rhs = {
-            L_inner: -Gamma_SEI * j_inner,
-            L_outer: -v_bar * Gamma_SEI * j_outer,
+            L_inner: -Gamma_SEI * a * j_inner,
+            L_outer: -v_bar * Gamma_SEI * a * j_outer,
         }
 
     def set_initial_conditions(self, variables):

diff --git a/pybamm/util.py b/pybamm/util.py
@@ -285,7 +285,10 @@ def load_function(filename):
 
     path = root_path.replace("/", ".")
     path = path.replace("\\", ".")
-    module_object = importlib.import_module(path)
+    try:
+        module_object = importlib.import_module(path)
+    except ModuleNotFoundError:
+        module_object = importlib.import_module("pybamm.input.parameters." + path)
 
     return getattr(module_object, tail)