#492 fix bugs

Author: valentinsulzer

examples/scripts/compare_lead_acid_3D.py

@@ -21,20 +21,22 @@
     #     {"current collector": "potential pair", "dimensionality": 2}, name="2+1D LOQS"
     # ),
     pybamm.lead_acid.Full(
-        {"current collector": "uniform", "dimensionality": 1}, name="1+1D Full"
+        {"current collector": "potential pair", "dimensionality": 1}, name="1+1D Full"
     ),
     # pybamm.lead_acid.Full(
     #     {"dimensionality": 1}, name="1+1D uniform Full"
     # ),
     pybamm.lead_acid.Composite(
-        {"current collector": "uniform", "dimensionality": 1}, name="1+1D composite"
+        {"current collector": "potential pair quite conductive", "dimensionality": 1},
+        name="1+1D composite",
     ),
     pybamm.lead_acid.Composite(
-        {"current collector": "uniform", "dimensionality": 1}, name="1+1D composite"
+        {"current collector": "potential pair", "dimensionality": 1},
+        name="1+1D composite",
     ),
     # # pybamm.lead_acid.Composite({"dimensionality": 1}, name="composite"),
     pybamm.lead_acid.LOQS(
-        {"current collector": "uniform", "dimensionality": 1}, name="1+1D LOQS"
+        {"current collector": "potential pair", "dimensionality": 1}, name="1+1D LOQS"
     ),
     # pybamm.lead_acid.LOQS({"dimensionality": 1}, name="LOQS"),
 ]

pybamm/models/full_battery_models/base_battery_model.py

@@ -493,11 +493,11 @@ def set_external_circuit_submodel(self):
         if self.options["operating mode"] == "current":
             self.submodels[
                 "external circuit"
-            ] = pybamm.external_circuit.ConstantCurrent(self.param)
+            ] = pybamm.external_circuit.CurrentControl(self.param)
         if self.options["operating mode"] == "voltage":
             self.submodels[
                 "external circuit"
-            ] = pybamm.external_circuit.ConstantVoltage(self.param)
+            ] = pybamm.external_circuit.VoltageControl(self.param)
 
     def set_tortuosity_submodels(self):
         self.submodels["electrolyte tortuosity"] = pybamm.tortuosity.Bruggeman(

pybamm/models/full_battery_models/lead_acid/full.py

@@ -34,6 +34,7 @@ class Full(BaseModel):
     def __init__(self, options=None, name="Full model", build=True):
         super().__init__(options, name)
 
+        self.set_external_circuit_submodel()
         self.set_reactions()
         self.set_interfacial_submodel()
         self.set_porosity_submodel()

pybamm/models/full_battery_models/lead_acid/higher_order.py

@@ -34,6 +34,7 @@ class BaseHigherOrderModel(BaseModel):
     def __init__(self, options=None, name="Composite model", build=True):
         super().__init__(options, name)
 
+        self.set_external_circuit_submodel()
         self.set_leading_order_model()
         self.set_reactions()
         # Electrolyte submodel to get first-order concentrations

pybamm/models/full_battery_models/lead_acid/loqs.py

@@ -33,6 +33,7 @@ class LOQS(BaseModel):
     def __init__(self, options=None, name="LOQS model", build=True):
         super().__init__(options, name)
 
+        self.set_external_circuit_submodel()
         self.set_reactions()
         self.set_interfacial_submodel()
         self.set_convection_submodel()

pybamm/models/full_battery_models/lithium_ion/dfn.py

@@ -33,6 +33,7 @@ class DFN(BaseModel):
     def __init__(self, options=None, name="Doyle-Fuller-Newman model", build=True):
         super().__init__(options, name)
 
+        self.set_external_circuit_submodel()
         self.set_reactions()
         self.set_porosity_submodel()
         self.set_tortuosity_submodels()

pybamm/models/full_battery_models/lithium_ion/spm.py

@@ -32,6 +32,7 @@ class SPM(BaseModel):
     def __init__(self, options=None, name="Single Particle Model", build=True):
         super().__init__(options, name)
 
+        self.set_external_circuit_submodel()
         self.set_porosity_submodel()
         self.set_tortuosity_submodels()
         self.set_convection_submodel()

pybamm/models/full_battery_models/lithium_ion/spme.py

@@ -35,6 +35,7 @@ def __init__(
     ):
         super().__init__(options, name)
 
+        self.set_external_circuit_submodel()
         self.set_reactions()
         self.set_porosity_submodel()
         self.set_tortuosity_submodels()

pybamm/models/submodels/current_collector/base_current_collector.py

@@ -35,8 +35,8 @@ def _get_standard_negative_potential_variables(self, phi_s_cn):
 
         Parameters
         ----------
-        phi_cc : :class:`pybamm.Symbol`
-            The potential in the current collector.
+        phi_s_cn : :class:`pybamm.Symbol`
+            The potential in the negative current collector.
 
         Returns
         -------
@@ -61,8 +61,10 @@ def _get_standard_potential_variables(self, phi_s_cn, phi_s_cp):
 
         Parameters
         ----------
-        phi_cc : :class:`pybamm.Symbol`
-            The potential in the current collector.
+        phi_s_cn : :class:`pybamm.Symbol`
+            The potential in the negative current collector.
+        phi_s_cp : :class:`pybamm.Symbol`
+            The potential in the positive current collector.
 
         Returns
         -------

pybamm/models/submodels/current_collector/homogeneous_current_collector.py

@@ -21,13 +21,10 @@ class Uniform(BaseModel):
     def __init__(self, param):
         super().__init__(param)
 
-    def get_derived_variables(self, variables):
+    def get_coupled_variables(self, variables):
 
         # TODO: grad not implemented for 2D yet
         i_cc = pybamm.Scalar(0)
-        import ipdb
-
-        ipdb.set_trace()
         i_boundary_cc = pybamm.PrimaryBroadcast(
             variables["Total current density"], "current collector"
         )
@@ -43,4 +40,5 @@ def get_derived_variables(self, variables):
         variables["Leading-order current collector current density"] = variables[
             "Current collector current density"
         ]
+
         return variables

pybamm/models/submodels/current_collector/quite_conductive_potential_pair.py

@@ -73,7 +73,7 @@ def set_algebraic(self, variables):
     def set_initial_conditions(self, variables):
 
         param = self.param
-        applied_current = variables["Total current density"]
+        applied_current = param.current_with_time
         cc_area = self._get_effective_current_collector_area()
         phi_s_cn = variables["Negative current collector potential"]
         i_boundary_cc = variables["Current collector current density"]

pybamm/models/submodels/electrode/base_electrode.py

@@ -40,24 +40,23 @@ def _get_standard_potential_variables(self, phi_s):
             electrode.
         """
         param = self.param
+        pot = param.potential_scale
         phi_s_av = pybamm.x_average(phi_s)
 
         if self.domain == "Negative":
-            phi_s_dim = param.potential_scale * phi_s
-            phi_s_av_dim = param.potential_scale * phi_s_av
+            phi_s_dim = pot * phi_s
+            phi_s_av_dim = pot * phi_s_av
             delta_phi_s = phi_s
 
         elif self.domain == "Positive":
-            phi_s_dim = param.U_p_ref - param.U_n_ref + param.potential_scale * phi_s
-            phi_s_av_dim = (
-                param.U_p_ref - param.U_n_ref + param.potential_scale * phi_s_av
-            )
+            phi_s_dim = param.U_p_ref - param.U_n_ref + pot * phi_s
+            phi_s_av_dim = param.U_p_ref - param.U_n_ref + pot * phi_s_av
 
             v = pybamm.boundary_value(phi_s, "right")
             delta_phi_s = phi_s - pybamm.PrimaryBroadcast(v, ["positive electrode"])
         delta_phi_s_av = pybamm.x_average(delta_phi_s)
-        delta_phi_s_dim = delta_phi_s * param.potential_scale
-        delta_phi_s_av_dim = delta_phi_s_av * param.potential_scale
+        delta_phi_s_dim = delta_phi_s * pot
+        delta_phi_s_av_dim = delta_phi_s_av * pot
 
         variables = {
             self.domain + " electrode potential": phi_s,
@@ -108,6 +107,41 @@ def _get_standard_current_variables(self, i_s):
 
         return variables
 
+    def _get_standard_current_collector_potential_variables(self, phi_s_cn, phi_s_cp):
+        """
+        A private function to obtain the standard variables which
+        can be derived from the potentials in the current collector.
+
+        Parameters
+        ----------
+        phi_cc : :class:`pybamm.Symbol`
+            The potential in the current collector.
+
+        Returns
+        -------
+        variables : dict
+            The variables which can be derived from the potential in the
+            current collector.
+        """
+
+        pot_scale = self.param.potential_scale
+        U_ref = self.param.U_p_ref - self.param.U_n_ref
+
+        # Local potential difference
+        V_cc = phi_s_cp - phi_s_cn
+
+        variables = {
+            "Negative current collector potential": phi_s_cn,
+            "Negative current collector potential [V]": phi_s_cn * pot_scale,
+            "Positive current collector potential": phi_s_cp,
+            "Positive current collector potential [V]": U_ref + phi_s_cp * pot_scale,
+            "Local current collector potential difference": V_cc,
+            "Local current collector potential difference [V]": U_ref
+            + V_cc * pot_scale,
+        }
+
+        return variables
+
     def _get_standard_whole_cell_variables(self, variables):
         """
         A private function to obtain the whole-cell versions of the
@@ -131,14 +165,23 @@ def _get_standard_whole_cell_variables(self, variables):
 
         i_s = pybamm.Concatenation(i_s_n, i_s_s, i_s_p)
 
+        variables.update({"Electrode current density": i_s})
         if self.set_positive_potential:
-            phi_s_p = variables["Positive electrode potential"]
-            phi_s_cp = pybamm.boundary_value(phi_s_p, "right")
-            variables = {
-                "Electrode current density": i_s,
-                "Positive current collector potential": phi_s_cp,
-            }
-        else:
-            variables = {"Electrode current density": i_s}
-
+            # don't overwrite current collector potentials
+            try:
+                phi_s_cn = variables["Negative current collector potential"]
+            except KeyError:
+                phi_s_n = variables["Negative electrode potential"]
+                phi_s_cn = pybamm.boundary_value(phi_s_n, "left")
+            try:
+                phi_s_cp = variables["Positive current collector potential"]
+            except KeyError:
+                phi_s_p = variables["Positive electrode potential"]
+                phi_s_cp = pybamm.boundary_value(phi_s_p, "right")
+            variables.update(
+                self._get_standard_current_collector_potential_variables(
+                    phi_s_cn, phi_s_cp
+                )
+            )
         return variables
+

pybamm/models/submodels/external_circuit/__init__.py

@@ -1,4 +1,3 @@
 from .base_external_circuit import BaseModel
 from .current_control_external_circuit import CurrentControl
-
-# from .voltage_control_external_circuit import VoltageControl
+from .voltage_control_external_circuit import VoltageControl

pybamm/models/submodels/external_circuit/current_control_external_circuit.py

@@ -21,7 +21,7 @@ def get_fundamental_variables(self):
             "Total current density": i_cell,
             "Total current density [A.m-2]": i_cell_dim,
             "Current [A]": I,
-            "Discharge capacity [A.h]": I * pybamm.t * self.param.time_scale / 3600,
+            "Discharge capacity [A.h]": I * pybamm.t * self.param.timescale / 3600,
         }
 
         return variables

pybamm/parameters/standard_parameters_lead_acid.py

@@ -277,6 +277,8 @@ def U_p_dimensional(c_e, T):
 # Electrolyte diffusion timescale
 tau_diffusion_e = L_x ** 2 / D_e_typ
 
+# Choose discharge timescale
+timescale = tau_discharge
 
 # --------------------------------------------------------------------------------------
 "4. Dimensionless Parameters"

pybamm/parameters/standard_parameters_lithium_ion.py

@@ -235,6 +235,9 @@ def U_p_dimensional(sto, T):
 # Thermal diffusion timescale
 tau_th_yz = pybamm.thermal_parameters.tau_th_yz
 
+# Choose discharge timescale
+timescale = tau_discharge
+
 # --------------------------------------------------------------------------------------
 "4. Dimensionless Parameters"
 # Timescale ratios