I3769 kolzenberg2020 (Another option for the SEI growth)

.gitignore

@@ -137,3 +137,4 @@ results/
 
 # tests
 test_callback.log
+# .mypy_cache/

CHANGELOG.md

@@ -11,19 +11,24 @@
 # [v24.11.0](https://github.com/pybamm-team/PyBaMM/tree/v24.11.0) - 2024-11-20
 
 ## Features
+- Added two more submodels (options) for the SEI: Lars von Kolzenberg (2020) model and Tunneling Limit model ([#4394](https://github.com/pybamm-team/PyBaMM/pull/4394))
+
+- Added the `pybamm.DiscreteTimeSum` expression node to sum an expression over a sequence of data times, and accompanying `pybamm.DiscreteTimeData` class to store the data times and values ([#4501](https://github.com/pybamm-team/PyBaMM/pull/4501))
 
 - Added `CoupledVariable` which provides a placeholder variable whose equation can be elsewhere in the model. ([#4556](https://github.com/pybamm-team/PyBaMM/pull/4556))
 - Adds support to `pybamm.Experiment` for the `output_variables` option in the `IDAKLUSolver`. ([#4534](https://github.com/pybamm-team/PyBaMM/pull/4534))
 - Adds an option "voltage as a state" that can be "false" (default) or "true". If "true" adds an explicit algebraic equation for the voltage. ([#4507](https://github.com/pybamm-team/PyBaMM/pull/4507))
+
 - Improved `QuickPlot` accuracy for simulations with Hermite interpolation. ([#4483](https://github.com/pybamm-team/PyBaMM/pull/4483))
 - Added Hermite interpolation to the (`IDAKLUSolver`) that improves the accuracy and performance of post-processing variables. ([#4464](https://github.com/pybamm-team/PyBaMM/pull/4464))
 - Added basic telemetry to record which functions are being run. See [Telemetry section in the User Guide](https://docs.pybamm.org/en/latest/source/user_guide/index.html#telemetry) for more information. ([#4441](https://github.com/pybamm-team/PyBaMM/pull/4441))
 - Added `BasicDFN` model for sodium-ion batteries ([#4451](https://github.com/pybamm-team/PyBaMM/pull/4451))
-- Added sensitivity calculation support for `pybamm.Simulation` and `pybamm.Experiment` ([#4415](https://github.com/pybamm-team/PyBaMM/pull/4415))
 - Added OpenMP parallelization to IDAKLU solver for lists of input parameters ([#4449](https://github.com/pybamm-team/PyBaMM/pull/4449))
-- Added phase-dependent particle options to LAM ([#4369](https://github.com/pybamm-team/PyBaMM/pull/4369))
+- Added sensitivity calculation support for `pybamm.Simulation` and `pybamm.Experiment` ([#4415](https://github.com/pybamm-team/PyBaMM/pull/4415))
+- Added phase-dependent particle options to LAM
+  ([#4369](https://github.com/pybamm-team/PyBaMM/pull/4369))
 - Added a lithium ion equivalent circuit model with split open circuit voltages for each electrode (`SplitOCVR`). ([#4330](https://github.com/pybamm-team/PyBaMM/pull/4330))
-- Added the `pybamm.DiscreteTimeSum` expression node to sum an expression over a sequence of data times, and accompanying `pybamm.DiscreteTimeData` class to store the data times and values ([#4501](https://github.com/pybamm-team/PyBaMM/pull/4501))
+
 
 ## Optimizations
 

benchmarks/different_model_options.py

@@ -184,6 +184,8 @@ class TimeSolveSEI(SolveModel):
             "electron-migration limited",
             "interstitial-diffusion limited",
             "ec reaction limited",
+            "tunnelling limited",
+            "VonKolzenberg2020",
         ],
         [pybamm.CasadiSolver, pybamm.IDAKLUSolver],
     )

docs/source/examples/notebooks/getting_started/tutorial-4-setting-parameter-values.ipynb

@@ -25,6 +25,9 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
+      "\n",
+      "\u001b[1m[\u001b[0m\u001b[34;49mnotice\u001b[0m\u001b[1;39;49m]\u001b[0m\u001b[39;49m A new release of pip is available: \u001b[0m\u001b[31;49m23.3.1\u001b[0m\u001b[39;49m -> \u001b[0m\u001b[32;49m24.0\u001b[0m\n",
+      "\u001b[1m[\u001b[0m\u001b[34;49mnotice\u001b[0m\u001b[1;39;49m]\u001b[0m\u001b[39;49m To update, run: \u001b[0m\u001b[32;49mpip install --upgrade pip\u001b[0m\n",
       "Note: you may need to restart the kernel to use updated packages.\n"
      ]
     }

src/pybamm/CITATIONS.bib

@@ -701,6 +701,17 @@ @article{Sulzer2021
   year = {2021}
 }
 
+@article{Tang2012,
+  title={Experimental and theoretical investigation of solid-electrolyte-interphase formation mechanisms on glassy carbon},
+  author={Tang, Maureen and Lu, Sida and Newman, John},
+  journal={Journal of The Electrochemical Society},
+  volume={159},
+  number={11},
+  pages={A1775},
+  year={2012},
+  publisher={IOP Publishing}
+}
+
 @article{Timms2021,
   title = {{Asymptotic Reduction of a Lithium-ion Pouch Cell Model}},
   author = {Timms, Robert and Marquis, Scott G and Sulzer, Valentin and Please, Colin P. and Chapman, S Jonathan},
@@ -758,6 +769,17 @@ @article{Virtanen2020
   doi = {10.1038/s41592-019-0686-2},
 }
 
+@article{VonKolzenberg2020,
+  title={Solid--electrolyte interphase during battery cycling: Theory of growth regimes},
+  author={von Kolzenberg, Lars and Latz, Arnulf and Horstmann, Birger},
+  journal={ChemSusChem},
+  volume={13},
+  number={15},
+  pages={3901--3910},
+  year={2020},
+  publisher={Wiley Online Library}
+}
+
 @article{Wang2002,
   title = {Spectral (Finite) Volume Method for Conservation Laws on Unstructured Grids},
   author = {Wang, Z. J.},

src/pybamm/models/full_battery_models/base_battery_model.py

@@ -153,7 +153,8 @@ class BatteryModelOptions(pybamm.FuzzyDict):
                 - "constant": :class:`pybamm.sei.Constant` (constant SEI thickness)
                 - "reaction limited", "reaction limited (asymmetric)", \
                     "solvent-diffusion limited", "electron-migration limited", \
-                    "interstitial-diffusion limited", "ec reaction limited" \
+                    "interstitial-diffusion limited", "ec reaction limited" ,   \
+                    "VonKolzenberg2020", "tunnelling limited",\
                     or "ec reaction limited (asymmetric)": :class:`pybamm.sei.SEIGrowth`
             * "SEI film resistance" : str
                 Set the submodel for additional term in the overpotential due to SEI.
@@ -305,6 +306,8 @@ def __init__(self, extra_options):
                 "interstitial-diffusion limited",
                 "ec reaction limited",
                 "ec reaction limited (asymmetric)",
+                "VonKolzenberg2020",
+                "tunnelling limited",
             ],
             "SEI film resistance": ["none", "distributed", "average"],
             "SEI on cracks": ["false", "true"],

src/pybamm/models/submodels/interface/sei/sei_growth.py

@@ -2,6 +2,7 @@
 # Class for SEI growth
 #
 import pybamm
+
 from .base_sei import BaseModel
 
 
@@ -37,6 +38,10 @@ def __init__(
         SEI_option = getattr(self.options, domain)["SEI"]
         if SEI_option == "ec reaction limited":
             pybamm.citations.register("Yang2017")
+        elif SEI_option == "VonKolzenberg2020":
+            pybamm.citations.register("VonKolzenberg2020")
+        elif SEI_option == "tunnelling limited":
+            pybamm.citations.register("Tang2012")
         else:
             pybamm.citations.register("Marquis2020")
 
@@ -123,6 +128,43 @@ def get_coupled_variables(self, variables):
             # Scott Marquis thesis (eq. 5.94)
             eta_inner = delta_phi - phase_param.U_sei
             j_sei = (eta_inner < 0) * phase_param.kappa_inner * eta_inner / L_sei
+
+        elif SEI_option == "tunnelling limited":  #
+            # This comes from eq.25 in Tang, M., Lu, S. and Newman, J., 2012.
+            # Experimental and theoretical investigation of solid-electrolyte-interphase formation mechanisms on glassy carbon.
+            # Journal of The Electrochemical Society, 159(11), p.A1775.
+            j_sei = (
+                -phase_param.j0_sei
+                * pybamm.exp(-alpha_SEI * F_RT * delta_phi)
+                * pybamm.exp(-phase_param.beta_tunnelling * L_sei)
+            )
+
+        elif SEI_option == "VonKolzenberg2020":
+            # Equation 19 in
+            # von Kolzenberg L, Latz A, Horstmann B.
+            # Solid electrolyte interphase during battery cycling:
+            # Theory of growth regimes. ChemSusChem. 2020 Aug 7;13(15):3901-10.
+            eta_bar = F_RT * (delta_phi)
+            L_diff = (
+                phase_param.D_li
+                * phase_param.c_li_0
+                * self.param.F
+                / phase_param.j0_sei
+            ) * pybamm.exp(-(1 - alpha_SEI) * eta_bar)
+            L_tun = phase_param.L_tunneling
+            L_app = (L_sei - L_tun) * ((L_sei - L_tun) > 0)
+            L_mig = (
+                2
+                / F_RT
+                * phase_param.kappa_Li_ion
+                / pybamm.maximum(pybamm.AbsoluteValue(j), 1e-38)
+            )
+            sign_j = 2 * (j > 0) - 1
+            LL_k = (1 - L_app / L_mig * sign_j) / (
+                1 - L_app / L_mig * sign_j + L_app / L_diff
+            )
+            j_sei = -phase_param.j0_sei * LL_k * pybamm.exp(-alpha_SEI * eta_bar)
+
         elif SEI_option == "interstitial-diffusion limited":
             # Scott Marquis thesis (eq. 5.96)
             j_sei = -(
@@ -144,6 +186,7 @@ def get_coupled_variables(self, variables):
             #  j = -F * c_0* k_exp() / (1 + L * k_exp() / D)
             #  c_ec = c_0 - L * k_exp() / D / (1 + L * k_exp() / D)
             #       = c_0 / (1 + L * k_exp() / D)
+            eta_SEI = delta_phi
             k_exp = phase_param.k_sei * pybamm.exp(-alpha_SEI * F_RT * eta_SEI)
             L_over_D = L_sei / phase_param.D_ec
             c_0 = phase_param.c_ec_0

src/pybamm/parameters/lithium_ion_parameters.py

@@ -2,6 +2,7 @@
 # Standard parameters for lithium-ion battery models
 #
 import pybamm
+
 from .base_parameters import BaseParameters, NullParameters
 
 
@@ -375,10 +376,18 @@ def _set_parameters(self):
         self.c_li_0 = pybamm.Parameter(
             f"{pref}Lithium interstitial reference concentration [mol.m-3]"
         )
+        self.kappa_Li_ion = pybamm.Parameter(
+            f"{pref}SEI lithium ion conductivity [S.m-1]"
+        )
         self.L_sei_0 = pybamm.Parameter(f"{pref}Initial SEI thickness [m]")
         self.L_sei_crack_0 = pybamm.Parameter(
             f"{pref}Initial SEI on cracks thickness [m]"
         )
+        self.L_tunneling = pybamm.Parameter(
+            f"{pref}Tunneling distance for electrons [m]"
+        )
+
+        self.beta_tunnelling = pybamm.Parameter(f"{pref}Tunneling barrier factor [m-1]")
 
         self.E_sei = pybamm.Parameter(f"{pref}SEI growth activation energy [J.mol-1]")
         self.alpha_SEI = pybamm.Parameter(f"{pref}SEI growth transfer coefficient")

tests/integration/test_models/test_full_battery_models/test_lithium_ion/base_lithium_ion_tests.py

@@ -1,11 +1,11 @@
 #
 # Base integration tests for lithium-ion models
 #
+import numpy as np
+
 import pybamm
 import tests
 
-import numpy as np
-
 
 class BaseIntegrationTestLithiumIon:
     def run_basic_processing_test(self, options, **kwargs):
@@ -204,6 +204,29 @@ def test_sei_ec_reaction_limited(self):
         }
         self.run_basic_processing_test(options)
 
+    def test_sei_VonKolzenberg2020(self):
+        options = {"SEI": "VonKolzenberg2020"}
+        parameter_values = pybamm.ParameterValues("Chen2020")
+        parameter_values.update(
+            {
+                "Tunneling distance for electrons [m]": 0,
+                "SEI lithium ion conductivity [S.m-1]": 1.0e-7,
+            },
+            check_already_exists=False,
+        )
+        self.run_basic_processing_test(options, parameter_values=parameter_values)
+
+    def test_sei_tunnelling_limited(self):
+        options = {
+            "SEI": "tunnelling limited",
+        }
+        parameter_values = pybamm.ParameterValues("Chen2020")
+        parameter_values.update(
+            {"Tunneling barrier factor [m-1]": 6.0e9},
+            check_already_exists=False,
+        )
+        self.run_basic_processing_test(options, parameter_values=parameter_values)
+
     def test_sei_asymmetric_ec_reaction_limited(self):
         options = {
             "SEI": "ec reaction limited (asymmetric)",

tests/integration/test_models/test_full_battery_models/test_lithium_ion/test_dfn.py

@@ -1,11 +1,12 @@
 #
 # Tests for the lithium-ion DFN model
 #
+import numpy as np
+import pytest
+
 import pybamm
 import tests
-import numpy as np
 from tests import BaseIntegrationTestLithiumIon
-import pytest
 
 
 class TestDFN(BaseIntegrationTestLithiumIon):

tests/integration/test_models/test_full_battery_models/test_lithium_ion/test_newman_tobias.py

@@ -1,9 +1,10 @@
 #
 # Tests for the lithium-ion Newman-Tobias model
 #
+import pytest
+
 import pybamm
 from tests import BaseIntegrationTestLithiumIon
-import pytest
 
 
 class TestNewmanTobias(BaseIntegrationTestLithiumIon):
@@ -32,3 +33,9 @@ def test_composite_reaction_driven_LAM(self):
 
     def test_composite_stress_driven_LAM(self):
         pass  # skip this test
+
+    def test_sei_VonKolzenberg2020(self):
+        pass  # skip this test
+
+    def test_sei_tunnelling_limited(self):
+        pass  # skip this test

tests/unit/test_citations.py

@@ -1,12 +1,14 @@
-import pytest
-import pybamm
-import os
-import io
 import contextlib
+import io
+import os
 import warnings
-from pybtex.database import Entry
 from tempfile import NamedTemporaryFile
 
+import pytest
+from pybtex.database import Entry
+
+import pybamm
+
 
 @contextlib.contextmanager
 def temporary_filename():
@@ -36,7 +38,8 @@ def test_citations(self):
 
         # Test key error
         with pytest.raises(KeyError):
-            citations._parse_citation("not a citation")  # this should raise key error
+            # this should raise key error
+            citations._parse_citation("not a citation")
 
         # Test unknown citations at registration
         assert "not a citation" in citations._unknown_citations
@@ -268,6 +271,36 @@ def test_brosaplanella_2022(self):
         assert "BrosaPlanella2022" in citations._citation_tags.keys()
         citations._reset()
 
+    def test_VonKolzenberg_2020(self):
+        # Test that calling relevant bits of code adds the right paper to citations
+        citations = pybamm.citations
+
+        citations._reset()
+        assert "VonKolzenberg2020" not in citations._papers_to_cite
+
+        pybamm.lithium_ion.SPMe(build=False, options={"SEI": "VonKolzenberg2020"})
+        assert "VonKolzenberg2020" in citations._papers_to_cite
+        citations._reset()
+
+        pybamm.lithium_ion.SPM(build=False, options={"SEI": "VonKolzenberg2020"})
+        assert "VonKolzenberg2020" in citations._papers_to_cite
+        citations._reset()
+
+    def test_tang_2012(self):
+        # Test that calling relevant bits of code adds the right paper to citations
+        citations = pybamm.citations
+
+        citations._reset()
+        assert "Tang2012" not in citations._papers_to_cite
+
+        pybamm.lithium_ion.SPMe(build=False, options={"SEI": "tunnelling limited"})
+        assert "Tang2012" in citations._papers_to_cite
+        citations._reset()
+
+        pybamm.lithium_ion.SPM(build=False, options={"SEI": "tunnelling limited"})
+        assert "Tang2012" in citations._papers_to_cite
+        citations._reset()
+
     def test_newman_tobias(self):
         # Test that calling relevant bits of code adds the right paper to citations
         citations = pybamm.citations

tests/unit/test_models/test_full_battery_models/test_base_battery_model.py

@@ -41,7 +41,7 @@
 'particle phases': '1' (possible: ['1', '2'])
 'particle shape': 'spherical' (possible: ['spherical', 'no particles'])
 'particle size': 'single' (possible: ['single', 'distribution'])
-'SEI': 'none' (possible: ['none', 'constant', 'reaction limited', 'reaction limited (asymmetric)', 'solvent-diffusion limited', 'electron-migration limited', 'interstitial-diffusion limited', 'ec reaction limited', 'ec reaction limited (asymmetric)'])
+'SEI': 'none' (possible: ['none', 'constant', 'reaction limited', 'reaction limited (asymmetric)', 'solvent-diffusion limited', 'electron-migration limited', 'interstitial-diffusion limited', 'ec reaction limited', 'ec reaction limited (asymmetric)', 'VonKolzenberg2020', 'tunnelling limited'])
 'SEI film resistance': 'none' (possible: ['none', 'distributed', 'average'])
 'SEI on cracks': 'false' (possible: ['false', 'true'])
 'SEI porosity change': 'false' (possible: ['false', 'true'])

tests/unit/test_models/test_full_battery_models/test_lithium_ion/base_lithium_ion_tests.py

@@ -280,6 +280,18 @@ def test_well_posed_sei_asymmetric_ec_reaction_limited(self):
         }
         self.check_well_posedness(options)
 
+    def test_well_posed_sei_VonKolzenberg2020_model(self):
+        options = {
+            "SEI": "VonKolzenberg2020",
+        }
+        self.check_well_posedness(options)
+
+    def test_well_posed_sei_tunnelling_limited(self):
+        options = {
+            "SEI": "tunnelling limited",
+        }
+        self.check_well_posedness(options)
+
     def test_well_posed_mechanics_negative_cracking(self):
         options = {"particle mechanics": ("swelling and cracking", "none")}
         self.check_well_posedness(options)