Merge pull request #1262 from pybamm-team/issue-1245-active-material

Issue 1245 active material

CHANGELOG.md

@@ -1,14 +1,20 @@
 # [Unreleased](https://github.com/pybamm-team/PyBaMM)
 
 ## Features
+
+-   Added submodels for active material ([#1262](https://github.com/pybamm-team/PyBaMM/pull/1262))
 -   Added composite surface form electrolyte models: `CompositeDifferential` and `CompositeAlgebraic` ([#1207](https://github.com/pybamm-team/PyBaMM/issues/1207))
 
 ## Optimizations
 
+-   Operations such as `1*x` and `0+x` now directly return `x` ([#1252](https://github.com/pybamm-team/PyBaMM/pull/1252))
+
 ## Bug fixes
 
 ## Breaking changes
 
+-   Operations such as `1*x` and `0+x` now directly return `x`. This can be bypassed by explicitly creating the binary operators, e.g. `pybamm.Multiplication(1, x)` ([#1252](https://github.com/pybamm-team/PyBaMM/pull/1252))
+
 # [v0.3.0](https://github.com/pybamm-team/PyBaMM) - 2020-11-22
 
 This release introduces a new aging model for particle swelling and cracking, a new reduced-order model (TSPMe), and a parameter set for A123 LFP cells. Additionally, there have been several backend optimizations to speed up model creation and solving, and other minor features and bug fixes.
@@ -27,7 +33,6 @@ This release introduces a new aging model for particle swelling and cracking, a
 
 ## Optimizations
 
--   Operations such as `1*x` and `0+x` now directly return `x` ([#1252](https://github.com/pybamm-team/PyBaMM/pull/1252))
 -   Add (optional) smooth approximations for the `Minimum`, `Maximum`, `Heaviside`, and `AbsoluteValue` operators ([#1223](https://github.com/pybamm-team/PyBaMM/pull/1223))
 -   Avoid unnecessary repeated computations in the solvers ([#1222](https://github.com/pybamm-team/PyBaMM/pull/1222))
 -   Rewrite `Symbol.is_constant` to be more efficient ([#1222](https://github.com/pybamm-team/PyBaMM/pull/1222))
@@ -46,8 +51,7 @@ This release introduces a new aging model for particle swelling and cracking, a
 
 ## Breaking changes
 
--   Operations such as `1*x` and `0+x` now directly return `x`. This can be bypassed by explicitly creating the binary operators, e.g. `pybamm.Multiplication(1, x)` ([#1252](https://github.com/pybamm-team/PyBaMM/pull/1252))
--   The parameters "Positive/Negative particle distribution in x" and "Positive/Negative surface area per unit volume distribution in x" have been deprecated. Instead, users can provide "Positive/Negative particle radius [m]" and "Positive/Negative surface area per unit volume [m-1]" directly as functions of through-cell position (x [m]) ([#1237](https://github.com/pybamm-team/PyBaMM/pull/1237))
+-    The parameters "Positive/Negative particle distribution in x" and "Positive/Negative surface area to volume ratio distribution in x" have been deprecated. Instead, users can provide "Positive/Negative particle radius [m]" and "Positive/Negative surface area to volume ratio [m-1]" directly as functions of through-cell position (x [m]) ([#1237](https://github.com/pybamm-team/PyBaMM/pull/1237)) 
 
 # [v0.2.4](https://github.com/pybamm-team/PyBaMM/tree/v0.2.4) - 2020-09-07
 
@@ -61,7 +65,7 @@ This release adds new operators for more complex models, some basic sensitivity
 -   Added particle submodel that use a polynomial approximation to the concentration within the electrode particles ([#1130](https://github.com/pybamm-team/PyBaMM/pull/1130))
 -   Added `Modulo`, `Floor` and `Ceiling` operators ([#1121](https://github.com/pybamm-team/PyBaMM/pull/1121))
 -   Added DFN model for a half cell ([#1121](https://github.com/pybamm-team/PyBaMM/pull/1121))
--   Automatically compute surface area per unit volume based on particle shape for li-ion models ([#1120](https://github.com/pybamm-team/PyBaMM/pull/1120))
+-   Automatically compute surface area to volume ratio based on particle shape for li-ion models ([#1120](https://github.com/pybamm-team/PyBaMM/pull/1120))
 -   Added "R-averaged particle concentration" variables ([#1118](https://github.com/pybamm-team/PyBaMM/pull/1118))
 -   Added support for sensitivity calculations to the casadi solver ([#1109](https://github.com/pybamm-team/PyBaMM/pull/1109))
 -   Added support for index 1 semi-explicit dae equations and sensitivity calculations to JAX BDF solver ([#1107](https://github.com/pybamm-team/PyBaMM/pull/1107))

examples/notebooks/Getting Started/Tutorial 3 - Basic plotting.ipynb

@@ -432,8 +432,8 @@
        " 'Sei interfacial current density',\n",
        " 'Sei interfacial current density [A.m-2]',\n",
        " 'Sei interfacial current density per volume [A.m-3]',\n",
-       " 'Negative surface area per unit volume distribution in x',\n",
-       " 'Positive surface area per unit volume distribution in x',\n",
+       " 'Negative surface area to volume ratio distribution in x',\n",
+       " 'Positive surface area to volume ratio distribution in x',\n",
        " 'Negative electrode interfacial current density',\n",
        " 'X-averaged negative electrode interfacial current density',\n",
        " 'Negative electrode interfacial current density [A.m-2]',\n",

examples/notebooks/models/SPM.ipynb

@@ -531,8 +531,8 @@
       "\t- Maximum negative particle surface concentration [mol.m-3]\n",
       "\t- Negative particle radius\n",
       "\t- Negative particle radius [m]\n",
-      "\t- Negative surface area per unit volume\n",
-      "\t- Negative surface area per unit volume [m-1]\n",
+      "\t- Negative surface area to volume ratio\n",
+      "\t- Negative surface area to volume ratio [m-1]\n",
       "\t- Positive particle concentration\n",
       "\t- Positive particle concentration [mol.m-3]\n",
       "\t- X-averaged positive particle concentration\n",
@@ -561,8 +561,8 @@
       "\t- Maximum positive particle surface concentration [mol.m-3]\n",
       "\t- Positive particle radius\n",
       "\t- Positive particle radius [m]\n",
-      "\t- Positive surface area per unit volume\n",
-      "\t- Positive surface area per unit volume [m-1]\n",
+      "\t- Positive surface area to volume ratio\n",
+      "\t- Positive surface area to volume ratio [m-1]\n",
       "\t- Electrolyte concentration\n",
       "\t- Electrolyte concentration [mol.m-3]\n",
       "\t- Electrolyte concentration [Molar]\n",

examples/notebooks/models/thermal-models.ipynb

@@ -60,7 +60,7 @@
     "\n",
     "with \n",
     "$$ Q_{Ohm,k} = -i_k \\nabla \\phi_k, \\quad Q_{rxn,k} = a_k j_k \\eta_k, \\quad Q_{rev,k} = a_k j_k T_k \\frac{\\partial U}{\\partial T} \\bigg|_{T=T_{\\infty}}.$$\n",
-    "Here $i_k$ is the current, $\\phi_k$ the potential, $a_k$ the surface area per unit volume, $j_k$ the interfacial current density, $\\eta_k$ the overpotential, and $U$ the open circuit potential. The averaged heat source term $\\bar{Q}$ is computed by taking the volume-average of $Q$."
+    "Here $i_k$ is the current, $\\phi_k$ the potential, $a_k$ the surface area to volume ratio, $j_k$ the interfacial current density, $\\eta_k$ the overpotential, and $U$ the open circuit potential. The averaged heat source term $\\bar{Q}$ is computed by taking the volume-average of $Q$."
    ]
   },
   {