Implement sodium-ion DFN (pybamm-team#4451)

* add sodium-ion model, parameters and examples * update citation keys to be consistent * rename electrolyte conductivity from kappa to sigma * add tests for sodium ion * fix doctests * fix doctest * remove accidentally added example * commented better the volume fraction * write volume fractions as a single number, not a substraction * improve basic tests * update CHANGELOG --------- Co-authored-by: Eric G. Kratz <kratman@users.noreply.github.com>
pkalbhor · Nov 15, 2024 · e629356 · e629356
1 parent 2894d96
commit e629356
Show file tree

Hide file tree

Showing 46 changed files with 1,402 additions and 275 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## Features
 
 - 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 `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

diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst
@@ -68,6 +68,7 @@ The notebooks are organised into subfolders, and can be viewed in the galleries
     notebooks/models/SEI-on-cracks.ipynb
     notebooks/models/simulate-3E-cell.ipynb
     notebooks/models/simulating-ORegan-2022-parameter-set.ipynb
+    notebooks/models/sodium-ion.ipynb
     notebooks/models/SPM.ipynb
     notebooks/models/SPMe.ipynb
     notebooks/models/submodel_cracking_DFN_or_SPM.ipynb

diff --git a/docs/source/examples/notebooks/models/sodium-ion.ipynb b/docs/source/examples/notebooks/models/sodium-ion.ipynb
diff --git a/pyproject.toml b/pyproject.toml
@@ -154,6 +154,7 @@ Ramadass2004 = "pybamm.input.parameters.lithium_ion.Ramadass2004:get_parameter_v
 Xu2019 = "pybamm.input.parameters.lithium_ion.Xu2019:get_parameter_values"
 ECM_Example = "pybamm.input.parameters.ecm.example_set:get_parameter_values"
 MSMR_Example = "pybamm.input.parameters.lithium_ion.MSMR_example_set:get_parameter_values"
+Chayambuka2022 = "pybamm.input.parameters.sodium_ion.Chayambuka2022:get_parameter_values"
 PKalbhor2024 = "pybamm.input.parameters.lithium_ion.PKalbhor2024:get_parameter_values"
 
 [tool.setuptools]