Issue 2040 events

CHANGELOG.md

@@ -1,5 +1,13 @@
 # [Unreleased](https://github.com/pybamm-team/PyBaMM/)
 
+## Features
+
+-   For experiments, the simulation now automatically checks and skips steps that cannot be performed (e.g. "Charge at 1C until 4.2V" from 100% SOC) ([#2212](https://github.com/pybamm-team/PyBaMM/pull/2212))
+
+## Breaking changes
+
+-   Events must now be defined in such a way that they are positive at the initial conditions (events will be triggered when they become negative, instead of when they change sign in either direction) ([#2212](https://github.com/pybamm-team/PyBaMM/pull/2212))
+
 # [v22.8](https://github.com/pybamm-team/PyBaMM/tree/v22.8) - 2022-08-31
 
 ## Features

pybamm/__init__.py

@@ -198,7 +198,7 @@
 #
 # Solver classes
 #
-from .solvers.solution import Solution, make_cycle_solution
+from .solvers.solution import Solution, EmptySolution, make_cycle_solution
 from .solvers.processed_variable import ProcessedVariable
 from .solvers.base_solver import BaseSolver
 from .solvers.dummy_solver import DummySolver

pybamm/expression_tree/exceptions.py

@@ -32,7 +32,8 @@ class SolverError(Exception):
     Solver error: a solution to the model could not be found with the chosen settings
     """
 
-    pass
+    def __init__(self, *args):
+        self.message = args[0]
 
 
 class SolverWarning(UserWarning):

pybamm/models/full_battery_models/base_battery_model.py

@@ -1340,7 +1340,7 @@ def x_not_zero(x):
         self.events.append(
             pybamm.Event(
                 "Maximum voltage",
-                V - self.param.voltage_high_cut,
+                self.param.voltage_high_cut - V,
                 pybamm.EventType.TERMINATION,
             )
         )

pybamm/models/full_battery_models/lead_acid/basic_full.py

@@ -231,13 +231,13 @@ def __init__(self, name="Basic full model"):
                     "Zero negative electrode porosity cut-off", pybamm.min(eps_n)
                 ),
                 pybamm.Event(
-                    "Max negative electrode porosity cut-off", pybamm.max(eps_n) - 1
+                    "Max negative electrode porosity cut-off", 1 - pybamm.max(eps_n)
                 ),
                 pybamm.Event(
                     "Zero positive electrode porosity cut-off", pybamm.min(eps_p)
                 ),
                 pybamm.Event(
-                    "Max positive electrode porosity cut-off", pybamm.max(eps_p) - 1
+                    "Max positive electrode porosity cut-off", 1 - pybamm.max(eps_p)
                 ),
             ]
         )
@@ -294,6 +294,6 @@ def __init__(self, name="Basic full model"):
         self.events.extend(
             [
                 pybamm.Event("Minimum voltage", voltage - param.voltage_low_cut),
-                pybamm.Event("Maximum voltage", voltage - param.voltage_high_cut),
+                pybamm.Event("Maximum voltage", param.voltage_high_cut - voltage),
             ]
         )

pybamm/models/full_battery_models/lithium_ion/basic_dfn.py

@@ -270,5 +270,5 @@ def __init__(self, name="Doyle-Fuller-Newman model"):
         # Events specify points at which a solution should terminate
         self.events += [
             pybamm.Event("Minimum voltage", voltage - param.voltage_low_cut),
-            pybamm.Event("Maximum voltage", voltage - param.voltage_high_cut),
+            pybamm.Event("Maximum voltage", param.voltage_high_cut - voltage),
         ]

pybamm/models/full_battery_models/lithium_ion/basic_dfn_half_cell.py

@@ -295,7 +295,7 @@ def __init__(self, options=None, name="Doyle-Fuller-Newman half cell model"):
         self.events.append(
             pybamm.Event(
                 "Maximum voltage",
-                voltage_dim - self.param.voltage_high_cut_dimensional,
+                self.param.voltage_high_cut_dimensional - voltage_dim,
                 pybamm.EventType.TERMINATION,
             )
         )

pybamm/models/full_battery_models/lithium_ion/basic_spm.py

@@ -179,5 +179,5 @@ def __init__(self, name="Single Particle Model"):
         }
         self.events += [
             pybamm.Event("Minimum voltage", V - param.voltage_low_cut),
-            pybamm.Event("Maximum voltage", V - param.voltage_high_cut),
+            pybamm.Event("Maximum voltage", param.voltage_high_cut - V),
         ]

pybamm/models/submodels/particle_mechanics/crack_propagation.py

@@ -107,8 +107,8 @@ def set_events(self, variables):
         self.events.append(
             pybamm.Event(
                 f"{domain} particle crack length larger than particle radius",
-                pybamm.max(l_cr)
-                - self.domain_param.prim.R_typ / self.domain_param.l_cr_0,
+                self.domain_param.prim.R_typ / self.domain_param.l_cr_0
+                - pybamm.max(l_cr),
                 pybamm.EventType.TERMINATION,
             )
         )

pybamm/models/submodels/porosity/base_porosity.py

@@ -118,7 +118,7 @@ def set_events(self, variables):
             self.events.append(
                 pybamm.Event(
                     "Max negative electrode porosity cut-off",
-                    pybamm.max(eps_n) - 1,
+                    1 - pybamm.max(eps_n),
                     pybamm.EventType.TERMINATION,
                 )
             )
@@ -134,7 +134,7 @@ def set_events(self, variables):
         self.events.append(
             pybamm.Event(
                 "Max positive electrode porosity cut-off",
-                pybamm.max(eps_p) - 1,
+                1 - pybamm.max(eps_p),
                 pybamm.EventType.TERMINATION,
             )
         )