Merge pull request #1022 from ferranbrosa/issue-718-cooling-area

Issue 718 cooling area

Author: rtimms

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Features
 
+-   Added arbitrary geometry to the lumped thermal model ([#718](https://github.com/pybamm-team/PyBaMM/issues/718))
 -   Allowed `ProcessedVariable` to handle cases where `len(solution.t)=1` ([#1020](https://github.com/pybamm-team/PyBaMM/pull/1020))
 -   Added `BackwardIndefiniteIntegral` symbol ([#1014](https://github.com/pybamm-team/PyBaMM/pull/1014))
 -   Added `plot` and `plot2D` to enable easy plotting of `pybamm.Array` objects ([#1008](https://github.com/pybamm-team/PyBaMM/pull/1008))

examples/notebooks/models/spm1.png

@@ -15,22 +15,22 @@ Negative tab centre z-coordinate [m],0.114,Tab at top,
 Positive tab width [m],0.04,,Estimated value
 Positive tab centre y-coordinate [m],0.147,,Estimated value
 Positive tab centre z-coordinate [m],0.114,Tab at top,
+Cell cooling surface area [m2],1.54E-1,,
+Cell volume [m3],2.70E-4,,
 ,,,
 # Electrical,,,
 Cell capacity [A.h],17,Manufacturer,
 Typical current [A],1,,
 Current function [A],1,default current function,
 ,,,
 # Density,,,
-Negative current collector density [kg.m-3],11300, same as electrode,
+Negative current collector density [kg.m-3],11300," same as electrode",
 Positive current collector density [kg.m-3],9375,same as electrode,
-
 ,,,
 # Specific heat capacity,,,
 Negative current collector specific heat capacity [J.kg-1.K-1],130,CRC Handbook of Chemistry and Physics,
 Positive current collector specific heat capacity [J.kg-1.K-1],256,NIST Chemistry WebBook SRD69,
 ,,,
 # Thermal conductivity,,,
 Negative current collector thermal conductivity [W.m-1.K-1],35,CRC Handbook of Chemistry and Physics,
-Positive current collector thermal conductivity [W.m-1.K-1],35,assume same as lead,
-
+Positive current collector thermal conductivity [W.m-1.K-1],35,assume same as lead,

examples/notebooks/models/spm2.png

@@ -9,6 +9,7 @@ Negative current collector surface heat transfer coefficient [W.m-2.K-1],0,,
 Positive current collector surface heat transfer coefficient [W.m-2.K-1],0,,
 Negative tab heat transfer coefficient [W.m-2.K-1],10,,
 Positive tab heat transfer coefficient [W.m-2.K-1],10,,
+Total heat transfer coefficient [W.m-2.K-1],10,,
 Edge heat transfer coefficient [W.m-2.K-1],0.3,,
 
 ,,,

pybamm/input/parameters/lead-acid/cells/BBOXX_Sulzer2019/parameters.csv

@@ -15,6 +15,8 @@ Negative tab centre z-coordinate [m],0.2, At top,
 Positive tab width [m],0.044,,
 Positive tab centre y-coordinate [m],0.137,,
 Positive tab centre z-coordinate [m],0.2,At top,
+Cell cooling surface area [m2],5.61E-2,,pouch
+Cell volume [m3],4.62E-6,,pouch
 ,,,
 # Current collector properties ,,,
 Negative current collector conductivity [S.m-1],59.6E6,,

pybamm/input/parameters/lead-acid/experiments/1C_discharge_from_full/parameters.csv

@@ -9,6 +9,8 @@ Positive electrode thickness [m],75.6E-6,Chen 2020,
 Positive current collector thickness [m],16E-6,Chen 2020,
 Electrode height [m],6.5E-2,Chen 2020,Not needed for 1D
 Electrode width [m],1.58,Chen 2020,Not needed for 1D
+Cell cooling surface area [m2],5.31E-3,Chen 2020,cylindrical
+Cell volume [m3],2.42E-5,Chen 2020,cylindrical
 ,,,
 # Current collector properties ,,,
 Negative current collector conductivity [S.m-1],58411000,CRC Handbook,copper
@@ -29,4 +31,4 @@ Positive current collector thermal conductivity [W.m-1.K-1],237,CRC Handbook,alu
 # Electrical,,,
 Cell capacity [A.h],5,Chen 2020,
 Typical current [A],5,Chen 2020,
-Current function [A],5,default current function,
+Current function [A],5,default current function,

pybamm/input/parameters/lithium-ion/cells/Kim2011/parameters.csv

@@ -9,6 +9,8 @@ Positive electrode thickness [m],67E-06,Peyman MPM,
 Positive current collector thickness [m],2.5E-05,Scott Moura FastDFN,no info from Peyman MPM
 Electrode height [m],1,KOKAM SLPB78205130H,Not needed for 1D
 Electrode width [m],0.2050,KOKAM SLPB78205130H,Not needed for 1D
+Cell cooling surface area [m2],0.41,,pouch
+Cell volume [m3]3.92E-5,,pouch
 ,,,
 # Current collector properties ,,,
 Negative current collector conductivity [S.m-1],59600000,LIONSIMBA,carbon

pybamm/input/parameters/lithium-ion/cells/LGM50_Chen2020/parameters.csv

@@ -9,6 +9,8 @@ Positive electrode thickness [m],5.4E-05,,
 Positive current collector thickness [m],2.5E-05,,
 Electrode height [m],1.01E-01,,
 Electrode width [m],8.50E-02,,
+Cell cooling surface area [m2],1.72E-2,,pouch (single layer)
+Cell volume [m3],1.61E-6,,pouch (single layer)
 ,,,
 # Electrical,,,
 Cell capacity [A.h], 0.15625, 7.5/48 (parameter set for a single layer cell),

pybamm/input/parameters/lithium-ion/cells/UMBL_Mohtat2020/parameters.csv

@@ -15,6 +15,8 @@ Negative tab centre z-coordinate [m],0.137,,Need to find actual value for KOKAM
 Positive tab width [m],0.04,,Need to find actual value for KOKAM cell
 Positive tab centre y-coordinate [m],0.147,,Need to find actual value for KOKAM cell
 Positive tab centre z-coordinate [m],0.137,,Need to find actual value for KOKAM cell
+Cell cooling surface area [m2],5.69E-2,,pouch
+Cell volume [m3],7.80E-6,,pouch
 ,,,
 # Current collector properties ,,,
 Negative current collector conductivity [S.m-1],59600000,LIONSIMBA,carbon
@@ -35,4 +37,4 @@ Positive current collector thermal conductivity [W.m-1.K-1],237,,
 # Electrical,,,
 Cell capacity [A.h],0.680616,,24 Ah/m2 * 0.137m * 0.207m
 Typical current [A],0.680616,,1C current
-Current function [A],0.680616,default current function,
+Current function [A],0.680616,default current function,

pybamm/input/parameters/lithium-ion/cells/kokam_Ecker2015/parameters.csv

@@ -8,6 +8,7 @@ Positive current collector surface heat transfer coefficient [W.m-2.K-1],0,,
 Negative tab heat transfer coefficient [W.m-2.K-1],0,,
 Positive tab heat transfer coefficient [W.m-2.K-1],0,,
 Edge heat transfer coefficient [W.m-2.K-1],5,Peyman MPM,
+Total heat transfer coefficient [W.m-2.K-1],5,Peyman MPM,
 Ambient temperature [K], 298.15,,
 ,,,
 # Electrical

pybamm/input/parameters/lithium-ion/cells/kokam_Marquis2019/parameters.csv

@@ -3,12 +3,8 @@ Name [units],Value,Reference,Notes
 ,,,
 # Temperature
 Reference temperature [K],298.15,25C,
-Negative current collector surface heat transfer coefficient [W.m-2.K-1],0,default,
-Positive current collector surface heat transfer coefficient [W.m-2.K-1],0,default,
-Negative tab heat transfer coefficient [W.m-2.K-1],10,default,
-Positive tab heat transfer coefficient [W.m-2.K-1],10,default,
-Edge heat transfer coefficient [W.m-2.K-1],0.3,default,
-Ambient temperature [K]," 298.15",,
+Total heat transfer coefficient [W.m-2.K-1],10,default,
+Ambient temperature [K],298.15,,
 ,,,
 # Electrical
 Number of electrodes connected in parallel to make a cell,1,,

pybamm/input/parameters/lithium-ion/experiments/1C_charge_from_empty_Mohtat2020/parameters.csv

@@ -8,7 +8,8 @@ Positive current collector surface heat transfer coefficient [W.m-2.K-1],0,Paper
 Negative tab heat transfer coefficient [W.m-2.K-1],10,Paper does not consider thermal effects,
 Positive tab heat transfer coefficient [W.m-2.K-1],10,Paper does not consider thermal effects,
 Edge heat transfer coefficient [W.m-2.K-1],0.3,Paper does not consider thermal effects,
-Ambient temperature [K], 298.15,,
+Total heat transfer coefficient [W.m-2.K-1],10,Paper does not consider thermal effects,
+Ambient temperature [K],298.15,,
 
 ,,,
 # Electrical

pybamm/input/parameters/lithium-ion/experiments/1C_discharge_from_full_Chen2020/parameters.csv

@@ -8,7 +8,8 @@ Positive current collector surface heat transfer coefficient [W.m-2.K-1],0,,
 Negative tab heat transfer coefficient [W.m-2.K-1],25,,
 Positive tab heat transfer coefficient [W.m-2.K-1],25,,
 Edge heat transfer coefficient [W.m-2.K-1],0.3,,
-Ambient temperature [K], 298.15,,
+Total heat transfer coefficient [W.m-2.K-1],25,,
+Ambient temperature [K],298.15,,
 
 ,,,
 # Electrical

pybamm/input/parameters/lithium-ion/experiments/1C_discharge_from_full_Ecker2015/parameters.csv

@@ -3,12 +3,13 @@ Name [units],Value,Reference,Notes
 ,,,
 # Temperature
 Reference temperature [K],298.15,25C,
-Ambient temperature [K], 298.15,,
+Ambient temperature [K],298.15,,
 Negative current collector surface heat transfer coefficient [W.m-2.K-1],0,,
 Positive current collector surface heat transfer coefficient [W.m-2.K-1],0,,
 Negative tab heat transfer coefficient [W.m-2.K-1],10,,
 Positive tab heat transfer coefficient [W.m-2.K-1],10,,
 Edge heat transfer coefficient [W.m-2.K-1],0.3,,
+Total heat transfer coefficient [W.m-2.K-1],10,,
 ,,,
 # Electrical
 Number of electrodes connected in parallel to make a cell,1,,

pybamm/input/parameters/lithium-ion/experiments/1C_discharge_from_full_Kim2011/parameters.csv

@@ -181,12 +181,25 @@ def options(self, extra_options):
             "current collector": "uniform",
             "particle": "Fickian diffusion",
             "thermal": "isothermal",
+            "cell_geometry": None,
             "external submodels": [],
             "sei": None,
         }
+        # Change the default for cell geometry based on which thermal option is provided
+        extra_options = extra_options or {}
+        thermal_option = extra_options.get(
+            "thermal", None
+        )  # return None if option not given
+        if thermal_option is None or thermal_option in ["isothermal", "lumped"]:
+            default_options["cell_geometry"] = "arbitrary"
+        else:
+            default_options["cell_geometry"] = "pouch"
+        # The "cell_geometry" option will still be overridden by extra_options if
+        # provided
+
         # Change the default for SEI film resistance based on which sei option is
         # provided
-        extra_options = extra_options or {}
+        # extra_options = extra_options or {}
         sei_option = extra_options.get("sei", None)  # return None if option not given
         if sei_option is None:
             default_options["sei film resistance"] = None
@@ -213,6 +226,13 @@ def options(self, extra_options):
                 raise pybamm.OptionError(
                     "convection not implemented for lithium-ion models"
                 )
+            if (
+                options["thermal"] in ["x-lumped", "x-full"]
+                and options["cell_geometry"] != "pouch"
+            ):
+                raise pybamm.OptionError(
+                    options["thermal"] + " model must have pouch geometry."
+                )
         if isinstance(self, pybamm.lead_acid.BaseModel):
             if options["thermal"] != "isothermal" and options["dimensionality"] != 0:
                 raise pybamm.OptionError(
@@ -273,6 +293,10 @@ def options(self, extra_options):
             raise pybamm.OptionError(
                 "Unknown thermal model '{}'".format(options["thermal"])
             )
+        if options["cell_geometry"] not in ["arbitrary", "pouch"]:
+            raise pybamm.OptionError(
+                "Unknown geometry '{}'".format(options["cell_geometry"])
+            )
         if options["sei"] not in [
             None,
             "constant",
@@ -548,13 +572,15 @@ def set_thermal_submodel(self):
 
         elif self.options["thermal"] == "lumped":
             thermal_submodel = pybamm.thermal.Lumped(
-                self.param, self.options["dimensionality"]
+                self.param,
+                self.options["dimensionality"],
+                self.options["cell_geometry"],
             )
 
         elif self.options["thermal"] == "x-lumped":
             if self.options["dimensionality"] == 0:
-                # With 0D current collectors x-lumped is equivalent to lumped
-                thermal_submodel = pybamm.thermal.Lumped(self.param)
+                # With 0D current collectors x-lumped is equivalent to lumped pouch
+                thermal_submodel = pybamm.thermal.Lumped(self.param, geometry="pouch")
             elif self.options["dimensionality"] == 1:
                 thermal_submodel = pybamm.thermal.pouch_cell.CurrentCollector1D(
                     self.param

pybamm/input/parameters/lithium-ion/experiments/1C_discharge_from_full_Marquis2019/parameters.csv

@@ -15,11 +15,15 @@ class Lumped(BaseThermal):
         The parameters to use for this submodel
     cc_dimension: int, optional
         The dimension of the current collectors. Can be 0 (default), 1 or 2.
+    geometry: string, optional
+        The geometry for the lumped thermal submodel. Can be "arbitrary" (default) or
+        pouch.
 
     **Extends:** :class:`pybamm.thermal.BaseThermal`
     """
 
-    def __init__(self, param, cc_dimension=0):
+    def __init__(self, param, cc_dimension=0, geometry="arbitrary"):
+        self.geometry = geometry
         super().__init__(param, cc_dimension)
 
     def get_fundamental_variables(self):
@@ -49,46 +53,53 @@ def set_rhs(self, variables):
         T_amb = variables["Ambient temperature"]
 
         # Account for surface area to volume ratio in cooling coefficient
-        # Note: assumes pouch cell geometry. The factor 1/delta^2 comes from
-        # the choice of non-dimensionalisation.
-        # TODO: allow for arbitrary surface area to volume ratio in order to model
-        # different cell geometries (see #718)
-        cell_volume = self.param.l * self.param.l_y * self.param.l_z
-
-        yz_cell_surface_area = self.param.l_y * self.param.l_z
-        yz_surface_cooling_coefficient = (
-            -(self.param.h_cn + self.param.h_cp)
-            * yz_cell_surface_area
-            / cell_volume
-            / (self.param.delta ** 2)
-        )
+        # The factor 1/delta^2 comes from the choice of non-dimensionalisation.
+        if self.geometry == "pouch":
+            cell_volume = self.param.l * self.param.l_y * self.param.l_z
+
+            yz_cell_surface_area = self.param.l_y * self.param.l_z
+            yz_surface_cooling_coefficient = (
+                -(self.param.h_cn + self.param.h_cp)
+                * yz_cell_surface_area
+                / cell_volume
+                / (self.param.delta ** 2)
+            )
 
-        negative_tab_area = self.param.l_tab_n * self.param.l_cn
-        negative_tab_cooling_coefficient = (
-            -self.param.h_tab_n * negative_tab_area / cell_volume / self.param.delta
-        )
+            negative_tab_area = self.param.l_tab_n * self.param.l_cn
+            negative_tab_cooling_coefficient = (
+                -self.param.h_tab_n * negative_tab_area / cell_volume / self.param.delta
+            )
 
-        positive_tab_area = self.param.l_tab_p * self.param.l_cp
-        positive_tab_cooling_coefficient = (
-            -self.param.h_tab_p * positive_tab_area / cell_volume / self.param.delta
-        )
+            positive_tab_area = self.param.l_tab_p * self.param.l_cp
+            positive_tab_cooling_coefficient = (
+                -self.param.h_tab_p * positive_tab_area / cell_volume / self.param.delta
+            )
 
-        edge_area = (
-            2 * self.param.l_y * self.param.l
-            + 2 * self.param.l_z * self.param.l
-            - negative_tab_area
-            - positive_tab_area
-        )
-        edge_cooling_coefficient = (
-            -self.param.h_edge * edge_area / cell_volume / self.param.delta
-        )
+            edge_area = (
+                2 * self.param.l_y * self.param.l
+                + 2 * self.param.l_z * self.param.l
+                - negative_tab_area
+                - positive_tab_area
+            )
+            edge_cooling_coefficient = (
+                -self.param.h_edge * edge_area / cell_volume / self.param.delta
+            )
 
-        total_cooling_coefficient = (
-            yz_surface_cooling_coefficient
-            + negative_tab_cooling_coefficient
-            + positive_tab_cooling_coefficient
-            + edge_cooling_coefficient
-        )
+            total_cooling_coefficient = (
+                yz_surface_cooling_coefficient
+                + negative_tab_cooling_coefficient
+                + positive_tab_cooling_coefficient
+                + edge_cooling_coefficient
+            )
+        elif self.geometry == "arbitrary":
+            cell_surface_area = self.param.a_cooling
+            cell_volume = self.param.v_cell
+            total_cooling_coefficient = (
+                -self.param.h_total
+                * cell_surface_area
+                / cell_volume
+                / (self.param.delta ** 2)
+            )
 
         self.rhs = {
             T_vol_av: (

pybamm/models/full_battery_models/base_battery_model.py

@@ -19,6 +19,8 @@
 L_y = pybamm.Parameter("Electrode width [m]")
 L_z = pybamm.Parameter("Electrode height [m]")
 A_cc = L_y * L_z  # Area of current collector
+A_cooling = pybamm.Parameter("Cell cooling surface area [m2]")
+V_cell = pybamm.Parameter("Cell volume [m3]")
 
 # Tab geometry
 L_tab_n = pybamm.Parameter("Negative tab width [m]")
@@ -55,6 +57,8 @@
 l_y = L_y / L_z
 l_z = L_z / L_z
 a_cc = l_y * l_z
+a_cooling = A_cooling / (L_z ** 2)
+v_cell = V_cell / (L_x * L_z ** 2)
 
 l = L / L_x
 delta = L_x / L_z  # Aspect ratio

pybamm/models/submodels/thermal/lumped.py

@@ -32,6 +32,8 @@
 L_y = pybamm.geometric_parameters.L_y
 L_z = pybamm.geometric_parameters.L_z
 A_cc = pybamm.geometric_parameters.A_cc
+A_cooling = pybamm.geometric_parameters.A_cooling
+V_cell = pybamm.geometric_parameters.V_cell
 W = L_y
 H = L_z
 A_cs = A_cc
@@ -315,6 +317,8 @@ def j0_p_Ox_dimensional(c_e, T):
 l_y = pybamm.geometric_parameters.l_y
 l_z = pybamm.geometric_parameters.l_z
 a_cc = pybamm.geometric_parameters.a_cc
+a_cooling = pybamm.geometric_parameters.a_cooling
+v_cell = pybamm.geometric_parameters.v_cell
 l = pybamm.geometric_parameters.l
 delta = pybamm.geometric_parameters.delta
 # In lead-acid the current collector and electrodes are the same (same thickness)
@@ -455,6 +459,7 @@ def j0_p_Ox_dimensional(c_e, T):
 h_tab_p = pybamm.thermal_parameters.h_tab_p
 h_cn = pybamm.thermal_parameters.h_cn
 h_cp = pybamm.thermal_parameters.h_cp
+h_total = pybamm.thermal_parameters.h_total
 
 B = (
     i_typ