Merge pull request #1917 from pybamm-team/issue-1903-power

Issue 1903 power
pybamm-team · Feb 8, 2022 · 171c80e · 171c80e
2 parents 88f95e8 + cde0406
commit 171c80e
Show file tree

Hide file tree

Showing 20 changed files with 309 additions and 113 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## Features
 
 -   Isothermal models now compute heat source terms (but the temperature remains constant). The models now also account for current collector heating when `dimensionality=0` [#1929](https://github.com/pybamm-team/PyBaMM/pull/1929))
+-   Added new models for power control and resistance control ([#1917](https://github.com/pybamm-team/PyBaMM/pull/1917))
 -   Initial concentrations can now be provided as a function of `r` as well as `x` ([#1866](https://github.com/pybamm-team/PyBaMM/pull/1866))
 
 ## Bug fixes

diff --git a/docs/source/models/submodels/external_circuit/current_control_external_circuit.rst b/docs/source/models/submodels/external_circuit/current_control_external_circuit.rst
diff --git a/.../source/models/submodels/external_circuit/explicit_control_external_circuit.rst b/.../source/models/submodels/external_circuit/explicit_control_external_circuit.rst
@@ -0,0 +1,13 @@
+Explicit control external circuit
+=================================
+
+Current is explicitly specified, either by a function or in terms of other variables.
+
+.. autoclass:: pybamm.external_circuit.ExplicitCurrentControl
+    :members:
+
+.. autoclass:: pybamm.external_circuit.ExplicitPowerControl
+    :members:
+
+.. autoclass:: pybamm.external_circuit.ExplicitResistanceControl
+    :members:
diff --git a/.../source/models/submodels/external_circuit/function_control_external_circuit.rst b/.../source/models/submodels/external_circuit/function_control_external_circuit.rst
@@ -10,5 +10,8 @@ Function control external circuit
 .. autoclass:: pybamm.external_circuit.PowerFunctionControl
     :members:
 
+.. autoclass:: pybamm.external_circuit.ResistanceFunctionControl
+    :members:
+
 .. autoclass:: pybamm.external_circuit.CCCVFunctionControl
     :members:
diff --git a/docs/source/models/submodels/external_circuit/index.rst b/docs/source/models/submodels/external_circuit/index.rst
@@ -11,5 +11,5 @@ variable to be constant.
 .. toctree::
   :maxdepth: 1
 
-  current_control_external_circuit
+  explicit_control_external_circuit
   function_control_external_circuit
diff --git a/examples/notebooks/models/using-submodels.ipynb b/examples/notebooks/models/using-submodels.ipynb
@@ -335,7 +335,7 @@
    "source": [
     "Submodels can be added to the `model.submodels` dictionary in the same way that we changed the submodels earlier. \n",
     "\n",
-    "We use the simplest model for the external circuit, which is the \"current control\" submodel"
+    "We use the simplest model for the external circuit, which is the explicit \"current control\" submodel"
    ]
   },
   {
@@ -344,7 +344,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "model.submodels[\"external circuit\"] = pybamm.external_circuit.CurrentControl(model.param)"
+    "model.submodels[\"external circuit\"] = pybamm.external_circuit.ExplicitCurrentControl(model.param)"
    ]
   },
   {

diff --git a/examples/scripts/custom_model.py b/examples/scripts/custom_model.py
@@ -11,7 +11,7 @@
 model = pybamm.lithium_ion.BaseModel(name="my li-ion model")
 
 # set choice of submodels
-model.submodels["external circuit"] = pybamm.external_circuit.CurrentControl(
+model.submodels["external circuit"] = pybamm.external_circuit.ExplicitCurrentControl(
     model.param
 )
 model.submodels["current collector"] = pybamm.current_collector.Uniform(model.param)

diff --git a/pybamm/models/full_battery_models/base_battery_model.py b/pybamm/models/full_battery_models/base_battery_model.py
@@ -65,12 +65,21 @@ class BatteryModelOptions(pybamm.FuzzyDict):
                 A 2-tuple can be provided for different behaviour in negative and
                 positive electrodes.
             * "operating mode" : str
-                Sets the operating mode for the model. Can be "current" (default),
-                "voltage" or "power". Alternatively, the operating mode can be
-                controlled with an arbitrary function by passing the function directly
-                as the option. In this case the function must define the residual of
-                an algebraic equation. The applied current will be solved for such
-                that the algebraic constraint is satisfied.
+                Sets the operating mode for the model. This determines how the current
+                is set. Can be:
+
+                - "current" (default) : the current is explicity supplied
+                - "voltage"/"power"/"resistance" : solve an algebraic equation for \
+                    current such that voltage/power/resistance is correct
+                - "differential power"/"differential resistance" : solve a \
+                    differential equation for the power or resistance
+                - "explicit power"/"explicit resistance" : current is defined in terms \
+                    of the voltage such that power/resistance is correct
+                - "CCCV": a special implementation of the common constant-current \
+                    constant-voltage charging protocol, via an ODE for the current
+                - callable : if a callable is given as this option, the function \
+                    defines the residual of an algebraic equation. The applied current \
+                    will be solved for such that the algebraic constraint is satisfied.
             * "particle" : str
                 Sets the submodel to use to describe behaviour within the particle.
                 Can be "Fickian diffusion" (default), "uniform profile",
@@ -186,7 +195,17 @@ def __init__(self, extra_options):
                 "reaction-driven",
                 "stress and reaction-driven",
             ],
-            "operating mode": ["current", "voltage", "power", "CCCV"],
+            "operating mode": [
+                "current",
+                "voltage",
+                "power",
+                "differential power",
+                "explicit power",
+                "resistance",
+                "differential resistance",
+                "explicit resistance",
+                "CCCV",
+            ],
             "particle": [
                 "Fickian diffusion",
                 "fast diffusion",
@@ -897,27 +916,36 @@ def set_external_circuit_submodel(self):
         e.g. (not necessarily constant-) current, voltage, etc
         """
         if self.options["operating mode"] == "current":
-            self.submodels["external circuit"] = pybamm.external_circuit.CurrentControl(
-                self.param
-            )
+            model = pybamm.external_circuit.ExplicitCurrentControl(self.param)
         elif self.options["operating mode"] == "voltage":
-            self.submodels[
-                "external circuit"
-            ] = pybamm.external_circuit.VoltageFunctionControl(self.param)
+            model = pybamm.external_circuit.VoltageFunctionControl(self.param)
         elif self.options["operating mode"] == "power":
-            self.submodels[
-                "external circuit"
-            ] = pybamm.external_circuit.PowerFunctionControl(self.param)
+            model = pybamm.external_circuit.PowerFunctionControl(
+                self.param, "algebraic"
+            )
+        elif self.options["operating mode"] == "differential power":
+            model = pybamm.external_circuit.PowerFunctionControl(
+                self.param, "differential without max"
+            )
+        elif self.options["operating mode"] == "explicit power":
+            model = pybamm.external_circuit.ExplicitPowerControl(self.param)
+        elif self.options["operating mode"] == "resistance":
+            model = pybamm.external_circuit.ResistanceFunctionControl(
+                self.param, "algebraic"
+            )
+        elif self.options["operating mode"] == "differential resistance":
+            model = pybamm.external_circuit.ResistanceFunctionControl(
+                self.param, "differential without max"
+            )
+        elif self.options["operating mode"] == "explicit resistance":
+            model = pybamm.external_circuit.ExplicitResistanceControl(self.param)
         elif self.options["operating mode"] == "CCCV":
-            self.submodels[
-                "external circuit"
-            ] = pybamm.external_circuit.CCCVFunctionControl(self.param)
+            model = pybamm.external_circuit.CCCVFunctionControl(self.param)
         elif callable(self.options["operating mode"]):
-            self.submodels[
-                "external circuit"
-            ] = pybamm.external_circuit.FunctionControl(
+            model = pybamm.external_circuit.FunctionControl(
                 self.param, self.options["operating mode"]
             )
+        self.submodels["external circuit"] = model
 
     def set_tortuosity_submodels(self):
         self.submodels["electrolyte tortuosity"] = pybamm.tortuosity.Bruggeman(
@@ -1139,10 +1167,11 @@ def set_voltage_variables(self):
         # Hack to avoid division by zero if i_cc is exactly zero
         # If i_cc is zero, i_cc_not_zero becomes 1. But multiplying by sign(i_cc) makes
         # the local resistance 'zero' (really, it's not defined when i_cc is zero)
-        i_cc_not_zero = ((i_cc > 0) + (i_cc < 0)) * i_cc + (i_cc >= 0) * (i_cc <= 0)
-        i_cc_dim_not_zero = ((i_cc_dim > 0) + (i_cc_dim < 0)) * i_cc_dim + (
-            i_cc_dim >= 0
-        ) * (i_cc_dim <= 0)
+        def x_not_zero(x):
+            return ((x > 0) + (x < 0)) * x + (x >= 0) * (x <= 0)
+
+        i_cc_not_zero = x_not_zero(i_cc)
+        i_cc_dim_not_zero = x_not_zero(i_cc_dim)
 
         self.variables.update(
             {
@@ -1193,9 +1222,16 @@ def set_voltage_variables(self):
             )
         )
 
-        # Power
+        # Power and resistance
         I_dim = self.variables["Current [A]"]
-        self.variables.update({"Terminal power [W]": I_dim * V_dim})
+        I_dim_not_zero = x_not_zero(I_dim)
+        self.variables.update(
+            {
+                "Terminal power [W]": I_dim * V_dim,
+                "Power [W]": I_dim * V_dim,
+                "Resistance [Ohm]": pybamm.sign(I_dim) * V_dim / I_dim_not_zero,
+            }
+        )
 
     def set_degradation_variables(self):
         """

diff --git a/pybamm/models/full_battery_models/lead_acid/loqs.py b/pybamm/models/full_battery_models/lead_acid/loqs.py
@@ -64,7 +64,7 @@ def set_external_circuit_submodel(self):
         if self.options["operating mode"] == "current":
             self.submodels[
                 "leading order external circuit"
-            ] = pybamm.external_circuit.LeadingOrderCurrentControl(self.param)
+            ] = pybamm.external_circuit.LeadingOrderExplicitCurrentControl(self.param)
         elif self.options["operating mode"] == "voltage":
             self.submodels[
                 "leading order external circuit"

diff --git a/pybamm/models/submodels/current_collector/homogeneous_current_collector.py b/pybamm/models/submodels/current_collector/homogeneous_current_collector.py
@@ -21,17 +21,20 @@ class Uniform(BaseModel):
     def __init__(self, param):
         super().__init__(param)
 
+    def get_fundamental_variables(self):
+        phi_s_cn = pybamm.PrimaryBroadcast(0, "current collector")
+        variables = self._get_standard_negative_potential_variables(phi_s_cn)
+        return variables
+
     def get_coupled_variables(self, variables):
 
         # TODO: grad not implemented for 2D yet
         i_cc = pybamm.Scalar(0)
         i_boundary_cc = pybamm.PrimaryBroadcast(
             variables["Total current density"], "current collector"
         )
-        phi_s_cn = pybamm.PrimaryBroadcast(0, "current collector")
 
-        variables = self._get_standard_negative_potential_variables(phi_s_cn)
-        variables.update(self._get_standard_current_variables(i_cc, i_boundary_cc))
+        variables = self._get_standard_current_variables(i_cc, i_boundary_cc)
 
         # Hack to get the leading-order current collector current density
         # Note that this should be different from the actual (composite) current

diff --git a/pybamm/models/submodels/electrolyte_diffusion/full_diffusion.py b/pybamm/models/submodels/electrolyte_diffusion/full_diffusion.py
@@ -113,13 +113,15 @@ def set_boundary_conditions(self, variables):
             T = variables["Cell temperature"]
             tor = variables["Electrolyte tortuosity"]
             i_boundary_cc = variables["Current collector current density"]
-            dce_dx = (
-                -(1 - param.t_plus(c_e, T))
+            lbc = (
+                pybamm.boundary_value(
+                    -(1 - param.t_plus(c_e, T))
+                    / (tor * param.gamma_e * param.D_e(c_e, T)),
+                    "left",
+                )
                 * i_boundary_cc
                 * param.C_e
-                / (tor * param.gamma_e * param.D_e(c_e, T))
             )
-            lbc = pybamm.boundary_value(dce_dx, "left")
         else:
             # left bc at anode/current collector interface
             lbc = pybamm.Scalar(0)

diff --git a/pybamm/models/submodels/external_circuit/__init__.py b/pybamm/models/submodels/external_circuit/__init__.py
@@ -1,9 +1,15 @@
 from .base_external_circuit import BaseModel, LeadingOrderBaseModel
-from .current_control_external_circuit import CurrentControl, LeadingOrderCurrentControl
+from .explicit_control_external_circuit import (
+    ExplicitCurrentControl,
+    ExplicitPowerControl,
+    ExplicitResistanceControl,
+    LeadingOrderExplicitCurrentControl,
+)
 from .function_control_external_circuit import (
     FunctionControl,
     VoltageFunctionControl,
     PowerFunctionControl,
+    ResistanceFunctionControl,
     CCCVFunctionControl,
     LeadingOrderFunctionControl,
     LeadingOrderVoltageFunctionControl,

diff --git a/pybamm/models/submodels/external_circuit/current_control_external_circuit.py b/pybamm/models/submodels/external_circuit/current_control_external_circuit.py