Merge pull request #1602 from tobykirk/size-distribution-DFN

DFN with particle size distributions
pybamm-team · Aug 24, 2021 · bf4c1eb · bf4c1eb
2 parents 15a71cc + e236e9c
commit bf4c1eb
Show file tree

Hide file tree

Showing 55 changed files with 1,521 additions and 417 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,10 @@
 # [Unreleased](https://github.com/pybamm-team/PyBaMM)
 
 ## Features
-
+-   Added submodels and functionality for particle-size distributions in the DFN model, including an
+example notebook ([#1602](https://github.com/pybamm-team/PyBaMM/pull/1602))
+-   Added UDDS and WLTC drive cycles  ([#1601](https://github.com/pybamm-team/PyBaMM/pull/1601))
 -   `pybamm.base_solver.solve` function can take a list of input parameters to calculate the sensitivities of the solution with respect to. Alternatively, it can be set  to `True` to calculate the sensitivities for all input parameters ([#1552](https://github.com/pybamm-team/PyBaMM/pull/1552))
--   Addes UDDS and WLTC drive cycles  ([#1601](https://github.com/pybamm-team/PyBaMM/pull/1601))
 -   Added capability for `quaternary` domains (in addition to `primary`, `secondary` and `tertiary`), increasing the maximum number of domains that a `Symbol` can have to 4. ([#1580](https://github.com/pybamm-team/PyBaMM/pull/1580))
 -   Tabs can now be placed at the bottom of the cell in 1+1D thermal models ([#1581](https://github.com/pybamm-team/PyBaMM/pull/1581)) 
 -   Added temperature dependence on electrode electronic conductivity ([#1570](https://github.com/pybamm-team/PyBaMM/pull/1570))
@@ -42,7 +43,7 @@
 -   Made parameters importable through pybamm ([#1475](https://github.com/pybamm-team/PyBaMM/pull/1475))
 
 ## Breaking changes
-
+-   Refactored the `particle` submodel module, with the models having no size distribution now found in `particle.no_distribution`, and those with a size distribution in `particle.size_distribution`. Renamed submodels to indicate the transport model (Fickian diffusion, polynomial profile) and if they are "x-averaged". E.g., `FickianManyParticles` and `FickianSingleParticle` are now `no_distribution.FickianDiffusion` and `no_distribution.XAveragedFickianDiffusion` ([#1602](https://github.com/pybamm-team/PyBaMM/pull/1602))
 -   Changed sensitivity API. Removed `ProcessedSymbolicVariable`, all sensitivity now handled within the solvers and `ProcessedVariable` ()  ([#1552](https://github.com/pybamm-team/PyBaMM/pull/1552))
 -   The `Yang2017` parameter set has been removed as the complete parameter set is not publicly available in the literature ([#1577](https://github.com/pybamm-team/PyBaMM/pull/1577))
 -   Changed how options are specified for the "loss of active material" and "particle cracking" submodels. "loss of active material" can now be one of "none", "stress-driven", or "reaction-driven", or a 2-tuple for different options in negative and positive electrode. Similarly "particle cracking" (now called "particle mechanics") can now be "none", "swelling only", "swelling and cracking", or a 2-tuple ([#1490](https://github.com/pybamm-team/PyBaMM/pull/1490))

diff --git a/docs/source/models/submodels/particle/fickian_many_particles.rst b/docs/source/models/submodels/particle/fickian_many_particles.rst
diff --git a/docs/source/models/submodels/particle/fickian_single_particle.rst b/docs/source/models/submodels/particle/fickian_single_particle.rst
diff --git a/docs/source/models/submodels/particle/index.rst b/docs/source/models/submodels/particle/index.rst
@@ -5,8 +5,5 @@ Particle
   :maxdepth: 1
 
   base_particle
-  fickian_single_particle
-  fickian_many_particles
-  polynomial_single_particle
-  polynomial_many_particles
+  no_distribution/index
   size_distribution/index
diff --git a/docs/source/models/submodels/particle/no_distribution/fickian_diffusion.rst b/docs/source/models/submodels/particle/no_distribution/fickian_diffusion.rst
@@ -0,0 +1,7 @@
+Fickian Diffusion
+=================
+
+.. autoclass:: pybamm.particle.no_distribution.FickianDiffusion
+    :members:
+
+
diff --git a/docs/source/models/submodels/particle/no_distribution/index.rst b/docs/source/models/submodels/particle/no_distribution/index.rst
@@ -0,0 +1,10 @@
+No Particle-Size Distribution
+=============================
+
+.. toctree::
+  :maxdepth: 1
+
+  fickian_diffusion
+  x_averaged_fickian_diffusion
+  polynomial_profile
+  x_averaged_polynomial_profile
diff --git a/docs/source/models/submodels/particle/no_distribution/polynomial_profile.rst b/docs/source/models/submodels/particle/no_distribution/polynomial_profile.rst
@@ -0,0 +1,5 @@
+Polynomial Profile
+==================
+
+.. autoclass:: pybamm.particle.no_distribution.PolynomialProfile
+    :members:
diff --git a/...urce/models/submodels/particle/no_distribution/x_averaged_fickian_diffusion.rst b/...urce/models/submodels/particle/no_distribution/x_averaged_fickian_diffusion.rst
@@ -0,0 +1,6 @@
+X-averaged Fickian Diffusion
+============================
+
+.. autoclass:: pybamm.particle.no_distribution.XAveragedFickianDiffusion
+    :members:
+
diff --git a/...rce/models/submodels/particle/no_distribution/x_averaged_polynomial_profile.rst b/...rce/models/submodels/particle/no_distribution/x_averaged_polynomial_profile.rst
@@ -0,0 +1,5 @@
+X-averaged Polynomial Profile
+=============================
+
+.. autoclass:: pybamm.particle.no_distribution.XAveragedPolynomialProfile
+    :members:
diff --git a/docs/source/models/submodels/particle/polynomial_many_particles.rst b/docs/source/models/submodels/particle/polynomial_many_particles.rst
diff --git a/docs/source/models/submodels/particle/polynomial_single_particle.rst b/docs/source/models/submodels/particle/polynomial_single_particle.rst
diff --git a/docs/source/models/submodels/particle/size_distribution/base_distribution.rst b/docs/source/models/submodels/particle/size_distribution/base_distribution.rst
@@ -1,6 +1,6 @@
 Particle Size Distribution Base Model
 =====================================
 
-.. autoclass:: pybamm.particle.BaseSizeDistribution
+.. autoclass:: pybamm.particle.size_distribution.BaseSizeDistribution
     :members:
 
diff --git a/...source/models/submodels/particle/size_distribution/fast_single_distribution.rst b/...source/models/submodels/particle/size_distribution/fast_single_distribution.rst
diff --git a/docs/source/models/submodels/particle/size_distribution/fickian_diffusion.rst b/docs/source/models/submodels/particle/size_distribution/fickian_diffusion.rst
@@ -0,0 +1,7 @@
+Fickian Diffusion
+=================
+
+.. autoclass:: pybamm.particle.size_distribution.FickianDiffusion
+    :members:
+
+
diff --git a/...rce/models/submodels/particle/size_distribution/fickian_single_distribution.rst b/...rce/models/submodels/particle/size_distribution/fickian_single_distribution.rst
diff --git a/docs/source/models/submodels/particle/size_distribution/index.rst b/docs/source/models/submodels/particle/size_distribution/index.rst
@@ -5,5 +5,7 @@ Particle Size Distribution
   :maxdepth: 1
 
   base_distribution
-  fickian_single_distribution
-  fast_single_distribution
+  fickian_diffusion
+  x_averaged_fickian_diffusion
+  uniform_profile
+  x_averaged_uniform_profile
diff --git a/docs/source/models/submodels/particle/size_distribution/uniform_profile.rst b/docs/source/models/submodels/particle/size_distribution/uniform_profile.rst
@@ -0,0 +1,5 @@
+Uniform Profile
+===============
+
+.. autoclass:: pybamm.particle.size_distribution.UniformProfile
+    :members:
diff --git a/...ce/models/submodels/particle/size_distribution/x_averaged_fickian_diffusion.rst b/...ce/models/submodels/particle/size_distribution/x_averaged_fickian_diffusion.rst
@@ -0,0 +1,6 @@
+X-averaged Fickian Diffusion
+============================
+
+.. autoclass:: pybamm.particle.size_distribution.XAveragedFickianDiffusion
+    :members:
+
diff --git a/...urce/models/submodels/particle/size_distribution/x_averaged_uniform_profile.rst b/...urce/models/submodels/particle/size_distribution/x_averaged_uniform_profile.rst
@@ -0,0 +1,5 @@
+X-averaged Uniform Profile
+==========================
+
+.. autoclass:: pybamm.particle.size_distribution.XAveragedUniformProfile
+    :members:
diff --git a/examples/notebooks/models/DFN-with-particle-size-distributions.ipynb b/examples/notebooks/models/DFN-with-particle-size-distributions.ipynb