#836 fix example

Author: valentinsulzer

examples/scripts/cycling_ageing_yang.py

@@ -1,43 +1,43 @@
 import pybamm as pb
-options = {"sei": "ec reaction limited",
-           "porosity": "variable porosity"}
+
+pb.set_logging_level("INFO")
+options = {"sei": "ec reaction limited", "sei porosity change": True}
 param = pb.ParameterValues(chemistry=pb.parameter_sets.Ramadass2004)
 model = pb.lithium_ion.DFN(options)
-experiment = pb.Experiment((
+experiment = pb.Experiment(
     [
         "Charge at 1 C until 4.2 V",
         "Hold at 4.2 V until C/10",
         "Rest for 5 minutes",
-        "Discharge at 2 C until 2.8 V (1 seconds period)",
+        "Discharge at 2 C until 2.8 V",
         "Rest for 5 minutes",
     ]
-    * 5 +
-    [
+    * 2
+    + [
         "Charge at 1 C until 4.2 V",
         "Hold at 4.2 V until C/20",
         "Rest for 30 minutes",
-        "Discharge at C/3 until 2.8 V(1 seconds period)",
+        "Discharge at C/3 until 2.8 V",
         "Charge at 1 C until 4.2 V",
         "Hold at 4.2 V until C/20",
         "Rest for 30 minutes",
-        "Discharge at 1 C until 2.8 V(1 seconds period)",
+        "Discharge at 1 C until 2.8 V",
         "Charge at 1 C until 4.2 V",
         "Hold at 4.2 V until C/20",
         "Rest for 30 minutes",
-        "Discharge at 2 C until 2.8 V(1 seconds period)",
+        "Discharge at 2 C until 2.8 V",
         "Charge at 1 C until 4.2 V",
         "Hold at 4.2 V until C/20",
         "Rest for 30 minutes",
-        "Discharge at 3 C until 2.8 V(1 seconds period)",
-    ]) * 2
+        "Discharge at 3 C until 2.8 V",
+    ]
 )
-sim = pb.Simulation(model, experiment=experiment,
-                    parameter_values=param)
-sim.solve(solver=pb.CasadiSolver(mode="safe"))
+sim = pb.Simulation(model, experiment=experiment, parameter_values=param)
+sim.solve(solver=pb.CasadiSolver(mode="safe", dt_max=120))
 sim.plot(
     [
         "Current [A]",
-        'Total current density [A.m-2]',
+        "Total current density [A.m-2]",
         "Terminal voltage [V]",
         "Discharge capacity [A.h]",
         "Electrolyte potential [V]",
@@ -48,4 +48,3 @@
         "X-averaged total negative electrode sei thickness [m]",
     ]
 )
-

pybamm/models/full_battery_models/base_battery_model.py

@@ -314,6 +314,12 @@ def options(self, extra_options):
                     options["sei film resistance"]
                 )
             )
+        if options["sei porosity change"] not in [True, False]:
+            raise pybamm.OptionError(
+                "Unknown sei porosity change '{}'".format(
+                    options["sei porosity change"]
+                )
+            )
 
         if options["dimensionality"] == 0:
             if options["current collector"] not in ["uniform"]:

tests/unit/test_models/test_full_battery_models/test_base_battery_model.py

@@ -127,6 +127,8 @@ def test_options(self):
             pybamm.BaseBatteryModel({"sei": "bad sei"})
         with self.assertRaisesRegex(pybamm.OptionError, "sei film resistance"):
             pybamm.BaseBatteryModel({"sei film resistance": "bad sei film resistance"})
+        with self.assertRaisesRegex(pybamm.OptionError, "sei porosity change"):
+            pybamm.BaseBatteryModel({"sei porosity change": "bad sei porosity change"})
         # variable defaults
         model = pybamm.BaseBatteryModel()
         self.assertEqual(model.options["sei film resistance"], None)