#847 update docs

Author: rtimms

docs/source/models/submodels/thermal/index.rst

@@ -7,5 +7,5 @@ Thermal
   base_thermal
   isothermal
   lumped
-  one_dimensional_x
+  x_full
   pouch_cell/index

docs/source/models/submodels/thermal/pouch_cell/base_pouch_cell.rst

@@ -1,8 +1,5 @@
-Base Models
-===========
+Base Thermal Model for "N+1D" Pouch Cell
+========================================
 
 .. autoclass:: pybamm.thermal.pouch_cell.BasePouchCell
     :members:
-
-.. autoclass:: pybamm.thermal.pouch_cell.LumpedPouchCell
-    :members:

docs/source/models/submodels/thermal/pouch_cell/index.rst

@@ -5,5 +5,5 @@ Pouch Cell
   :maxdepth: 1
 
   base_pouch_cell
-  pouch_cell_1plus1D
-  pouch_cell_2plus1D
+  pouch_cell_1D_current_collectors
+  pouch_cell_2D_current_collectors

docs/source/models/submodels/thermal/pouch_cell/pouch_cell_1plus1D.rst docs/source/models/submodels/thermal/pouch_cell/pouch_cell_1D_current_collectors.rst

@@ -1,5 +1,5 @@
-1+1D Model
-==========
+Thermal Model for "1+1D" Pouch Cell
+===================================
 
 .. autoclass:: pybamm.thermal.pouch_cell.CurrentCollector1D
     :members:

docs/source/models/submodels/thermal/pouch_cell/pouch_cell_2plus1D.rst docs/source/models/submodels/thermal/pouch_cell/pouch_cell_2D_current_collectors.rst

@@ -1,5 +1,5 @@
-2+1D Model
-==========
+Thermal Model for "2+1D" Pouch Cell
+===================================
 
 .. autoclass:: pybamm.thermal.pouch_cell.CurrentCollector2D
     :members:

pybamm/models/full_battery_models/base_battery_model.py

@@ -442,9 +442,8 @@ def set_thermal_submodel(self):
 
         elif self.options["thermal"] == "x-lumped":
             if self.options["dimensionality"] == 0:
-                thermal_submodel = pybamm.thermal.Lumped(
-                    self.param, self.options["dimensionality"]
-                )
+                # With 0D current collectors x-lumped is equivalent to lumped
+                thermal_submodel = pybamm.thermal.Lumped(self.param)
             elif self.options["dimensionality"] == 1:
                 thermal_submodel = pybamm.thermal.pouch_cell.CurrentCollector1D(
                     self.param

pybamm/models/submodels/thermal/base_thermal.py

@@ -25,13 +25,13 @@ def _get_standard_fundamental_variables(
         self, T_cn, T_n, T_s, T_p, T_cp, T_x_av, T_vol_av
     ):
         """
-        Here we explicitly pass in the averages for the temperature as they are
-        computed differently in different models. Computing the average temperature
-        using `self._x_average` requires a messy hack to avoid raising a
-        `ModelError` (as the key in the equation gets modified).
+        Note: here we explicitly pass in the averages for the temperature as computing
+        the average temperature in `BaseThermal` using `self._x_average` requires a
+        messy hack to avoid raising a `ModelError` (as the key in the equation
+        dict gets modified).
 
-        For more information about this method in general see
-        :meth:`pybamm.base_submodel._get_standard_fundamental_variables`
+        For more information about this method in general,
+        see :meth:`pybamm.base_submodel._get_standard_fundamental_variables`
         """
         param = self.param
 

pybamm/models/submodels/thermal/lumped.py

@@ -53,6 +53,7 @@ def set_rhs(self, variables):
         # 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)
         A = self.param.l_y * self.param.l_z
         V = self.param.l * self.param.l_y * self.param.l_z
         cooling_coeff = -2 * self.param.h * A / V / (self.param.delta ** 2)

tests/unit/test_models/test_submodels/test_thermal/test_lumped.py

@@ -23,7 +23,7 @@ def test_public_functions(self):
         std_tests = tests.StandardSubModelTests(submodel, coupled_variables)
         std_tests.test_all()
 
-        submodel = pybamm.thermal.Lumped(param, cc_dimension=1)
+        submodel = pybamm.thermal.Lumped(param, cc_dimension=2)
         std_tests = tests.StandardSubModelTests(submodel, coupled_variables)
         std_tests.test_all()
 

tests/unit/test_models/test_submodels/test_thermal/test_pouch_cell/test_base_pouch_cell.py

@@ -14,16 +14,6 @@
 class TestPouchCell1D(unittest.TestCase):
     def test_public_functions(self):
         param = pybamm.standard_parameters_lithium_ion
-        phi_s_cn = pybamm.PrimaryBroadcast(pybamm.Scalar(0), ["current collector"])
-        phi_s_cp = pybamm.PrimaryBroadcast(pybamm.Scalar(3), ["current collector"])
-
-        coupled_variables.update(
-            {
-                "Negative current collector potential": phi_s_cn,
-                "Positive current collector potential": phi_s_cp,
-            }
-        )
-
         submodel = pybamm.thermal.pouch_cell.CurrentCollector1D(param)
         std_tests = tests.StandardSubModelTests(submodel, coupled_variables)
         std_tests.test_all()

tests/unit/test_models/test_submodels/test_thermal/test_pouch_cell/test_pouch_1plus1D.py

@@ -14,16 +14,6 @@
 class TestPouchCell2D(unittest.TestCase):
     def test_public_functions(self):
         param = pybamm.standard_parameters_lithium_ion
-        phi_s_cn = pybamm.PrimaryBroadcast(pybamm.Scalar(0), ["current collector"])
-        phi_s_cp = pybamm.PrimaryBroadcast(pybamm.Scalar(3), ["current collector"])
-
-        coupled_variables.update(
-            {
-                "Negative current collector potential": phi_s_cn,
-                "Positive current collector potential": phi_s_cp,
-            }
-        )
-
         submodel = pybamm.thermal.pouch_cell.CurrentCollector2D(param)
         std_tests = tests.StandardSubModelTests(submodel, coupled_variables)
         std_tests.test_all()