diff --git a/CHANGELOG.md b/CHANGELOG.md index fea7c859a3..010df6a121 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ - Moved general code about submodels to `BaseModel` instead of `BaseBatteryModel`, making it easier to build custom models from submodels. ([#2169](https://github.com/pybamm-team/PyBaMM/pull/2169)) - Events can now be plotted as a regular variable (under the name "Event: event_name", e.g. "Event: Minimum voltage [V]") ([#2158](https://github.com/pybamm-team/PyBaMM/pull/2158)) +- SEI growth, lithium plating and porosity change can now be set to distributed in `SPMe`. There is an additional option called `x-average side reactions` which allows to set this (note that for `SPM` it is always x-averaged). ([#2099](https://github.com/pybamm-team/PyBaMM/pull/2099)) ## Optimizations @@ -208,7 +209,7 @@ This release introduces: - 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)) -- Added LG M50 (NMC811 and graphite + SiOx) parameter set from O'Regan 2021 ([#1594](https://github.com/pybamm-team/PyBaMM/pull/1594)) +- Added LG M50 (NMC811 and graphite + SiOx) parameter set from O'Regan 2022 ([#1594](https://github.com/pybamm-team/PyBaMM/pull/1594)) - `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)) - 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)) diff --git a/benchmarks/time_setup_models_and_sims.py b/benchmarks/time_setup_models_and_sims.py index a2689e7b2a..dfe793c727 100644 --- a/benchmarks/time_setup_models_and_sims.py +++ b/benchmarks/time_setup_models_and_sims.py @@ -2,7 +2,7 @@ parameters = [ "Marquis2019", - "ORegan2021", + "ORegan2022", "NCA_Kim2011", "Prada2013", "Ai2020", diff --git a/benchmarks/time_solve_models.py b/benchmarks/time_solve_models.py index 235043badc..da81c25596 100644 --- a/benchmarks/time_solve_models.py +++ b/benchmarks/time_solve_models.py @@ -15,7 +15,7 @@ class TimeSolveSPM: [False, True], [ "Marquis2019", - "ORegan2021", + "ORegan2022", "NCA_Kim2011", "Prada2013", # "Ai2020", @@ -69,7 +69,7 @@ class TimeSolveSPMe: [False, True], [ "Marquis2019", - "ORegan2021", + "ORegan2022", "NCA_Kim2011", "Prada2013", # "Ai2020", @@ -123,7 +123,7 @@ class TimeSolveDFN: [False, True], [ "Marquis2019", - "ORegan2021", + "ORegan2022", # "NCA_Kim2011", "Prada2013", "Ai2020", diff --git a/examples/notebooks/models/simulating-ORegan-2021-parameter-set.ipynb b/examples/notebooks/models/simulating-ORegan-2022-parameter-set.ipynb similarity index 94% rename from examples/notebooks/models/simulating-ORegan-2021-parameter-set.ipynb rename to examples/notebooks/models/simulating-ORegan-2022-parameter-set.ipynb index 31cea602c0..a1070c9d35 100644 --- a/examples/notebooks/models/simulating-ORegan-2021-parameter-set.ipynb +++ b/examples/notebooks/models/simulating-ORegan-2022-parameter-set.ipynb @@ -5,9 +5,9 @@ "id": "global-street", "metadata": {}, "source": [ - "# Run simulations with O'Regan 2021 parameter set (LG M50)\n", + "# Run simulations with O'Regan 2022 parameter set (LG M50)\n", "\n", - "In this notebook we show an example on how to run the DFN model with the O'Regan 2021 parameter set for the LG M50 cell. Because of the concentration dependent diffusion coefficient, we need to customise the mesh so the simulations converge." + "In this notebook we show an example on how to run the DFN model with the O'Regan 2022 parameter set for the LG M50 cell. Because of the concentration dependent diffusion coefficient, we need to customise the mesh so the simulations converge." ] }, { @@ -48,8 +48,8 @@ "options = {\"thermal\": \"lumped\", \"dimensionality\": 0, \"cell geometry\": \"arbitrary\"}\n", "model = pybamm.lithium_ion.DFN(options=options)\n", "\n", - "# O'Regan 2021 parameter set\n", - "param = pybamm.ParameterValues(\"ORegan2021\")\n", + "# O'Regan 2022 parameter set\n", + "param = pybamm.ParameterValues(\"ORegan2022\")\n", "\n", "# Choose CasADI fast (we do a short discharge so there are no events, if events are needed choose \"fast with events\")\n", "solver = pybamm.CasadiSolver(mode=\"fast\")" @@ -163,7 +163,7 @@ ], "metadata": { "kernelspec": { - "display_name": "Python 3 (ipykernel)", + "display_name": "Python 3.7.4 ('dev': venv)", "language": "python", "name": "python3" }, @@ -177,7 +177,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.0" + "version": "3.7.4" }, "toc": { "base_numbering": 1, @@ -191,6 +191,11 @@ "toc_position": {}, "toc_section_display": true, "toc_window_display": true + }, + "vscode": { + "interpreter": { + "hash": "0f0e5a277ebcf03e91e138edc3d4774b5dee64e7d6640c0d876f99a9f6b2a4dc" + } } }, "nbformat": 4, diff --git a/pybamm/CITATIONS.txt b/pybamm/CITATIONS.txt index 34c50da52d..dcf85599ee 100644 --- a/pybamm/CITATIONS.txt +++ b/pybamm/CITATIONS.txt @@ -35,6 +35,18 @@ doi = {10.1016/j.electacta.2021.138524}, } +@article{BrosaPlanella2022, + author = {Brosa Planella, Ferran and Widanage, W. Dhammika}, + title = {{Systematic derivation of a Single Particle Model with Electrolyte and Side Reactions (SPMe+SR) for degradation of lithium-ion batteries}}, + journal = {Submitted for publication}, + volume = {}, + number = {}, + pages = {}, + year = {2022}, + publisher = {}, + doi = {}, +} + @article{Chen2020, author = {Chen, Chang-Hui and Brosa Planella, Ferran and O'Regan, Kieran and Gastol, Dominika and Widanage, W. Dhammika and Kendrick, Emma}, title = {{Development of Experimental Techniques for Parameterization of Multi-scale Lithium-ion Battery Models}}, @@ -309,17 +321,15 @@ url ="http://dx.doi.org/10.1039/D2CP00417H", } - -@article{ORegan2021, +@article{ORegan2022, author = {O'Regan, Kieran and Brosa Planella, Ferran and Widanage, W. Dhammika and Kendrick, Emma}, - title = {{Thermal-electrochemical parametrisation of a lithium-ion battery: mapping Li concentration and temperature dependencies}}, - journal = {Journal of The Electrochemical Society}, - volume = {}, - number = {}, - pages = {}, - year = {2021}, - publisher = {The Electrochemical Society}, - doi = {}, + title = {{Thermal-electrochemical parameters of a high energy lithium-ion cylindrical battery}}, + journal = {{Electrochimica Acta}}, + volume = {425}, + pages = {140700}, + year = {2022}, + publisher = {Elsevier}, + doi = {10.1016/j.electacta.2022.140700}, } @article{Prada2013, diff --git a/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2021/README.md b/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2021/README.md deleted file mode 100644 index 3f1acb6d1b..0000000000 --- a/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2021/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# LG M50 cell parameters - -Parameters for an LG M50 cell, from the paper - -> Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma Kendrick. ["Thermal-electrochemical parametrisation of a lithium-ion battery: mapping Li concentration and temperature dependencies."]() Journal of the Electrochemical Society, submitted (2021) - -and references therein. diff --git a/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2022/README.md b/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2022/README.md new file mode 100644 index 0000000000..cabdc81835 --- /dev/null +++ b/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2022/README.md @@ -0,0 +1,7 @@ +# LG M50 cell parameters + +Parameters for an LG M50 cell, from the paper + +> Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma Kendrick. ["Thermal-electrochemical parameters of a high energy lithium-ion cylindrical battery."](https://www.sciencedirect.com/science/article/pii/S0013468622008593) Electrochimica Acta 425 (2022): 140700 + +and references therein. diff --git a/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2021/__init__.py b/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2022/__init__.py similarity index 100% rename from pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2021/__init__.py rename to pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2022/__init__.py diff --git a/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2021/aluminium_heat_capacity_CRC.py b/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2022/aluminium_heat_capacity_CRC.py similarity index 100% rename from pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2021/aluminium_heat_capacity_CRC.py rename to pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2022/aluminium_heat_capacity_CRC.py diff --git a/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2021/copper_heat_capacity_CRC.py b/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2022/copper_heat_capacity_CRC.py similarity index 100% rename from pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2021/copper_heat_capacity_CRC.py rename to pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2022/copper_heat_capacity_CRC.py diff --git a/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2021/copper_thermal_conductivity_CRC.py b/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2022/copper_thermal_conductivity_CRC.py similarity index 100% rename from pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2021/copper_thermal_conductivity_CRC.py rename to pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2022/copper_thermal_conductivity_CRC.py diff --git a/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2021/parameters.csv b/pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2022/parameters.csv similarity index 100% rename from pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2021/parameters.csv rename to pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2022/parameters.csv diff --git a/pybamm/input/parameters/lithium_ion/experiments/1C_discharge_from_full_ORegan2021/README.md b/pybamm/input/parameters/lithium_ion/experiments/1C_discharge_from_full_ORegan2021/README.md deleted file mode 100644 index 46e7772ab5..0000000000 --- a/pybamm/input/parameters/lithium_ion/experiments/1C_discharge_from_full_ORegan2021/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# 1C discharge from full - -Discharge lithium-ion battery from full charge at 1C, using the initial conditions from the paper - -> Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma Kendrick. ["Thermal-electrochemical parametrisation of a lithium-ion battery: mapping Li concentration and temperature dependencies."]() Journal of the Electrochemical Society, submitted (2021) - -and references therein. diff --git a/pybamm/input/parameters/lithium_ion/experiments/1C_discharge_from_full_ORegan2022/README.md b/pybamm/input/parameters/lithium_ion/experiments/1C_discharge_from_full_ORegan2022/README.md new file mode 100644 index 0000000000..904a40e7c9 --- /dev/null +++ b/pybamm/input/parameters/lithium_ion/experiments/1C_discharge_from_full_ORegan2022/README.md @@ -0,0 +1,7 @@ +# 1C discharge from full + +Discharge lithium-ion battery from full charge at 1C, using the initial conditions from the paper + +> Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma Kendrick. ["Thermal-electrochemical parameters of a high energy lithium-ion cylindrical battery."](https://www.sciencedirect.com/science/article/pii/S0013468622008593) Electrochimica Acta 425 (2022): 140700 + +and references therein. diff --git a/pybamm/input/parameters/lithium_ion/experiments/1C_discharge_from_full_ORegan2021/parameters.csv b/pybamm/input/parameters/lithium_ion/experiments/1C_discharge_from_full_ORegan2022/parameters.csv similarity index 100% rename from pybamm/input/parameters/lithium_ion/experiments/1C_discharge_from_full_ORegan2021/parameters.csv rename to pybamm/input/parameters/lithium_ion/experiments/1C_discharge_from_full_ORegan2022/parameters.csv diff --git a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/README.md b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/README.md deleted file mode 100644 index 76d2438618..0000000000 --- a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# LG M50 Graphite negative electrode parameters - -Parameters for a LG M50 graphite negative electrode, from the paper - -> Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma Kendrick. ["Thermal-electrochemical parametrisation of a lithium-ion battery: mapping Li concentration and temperature dependencies."]() Journal of the Electrochemical Society, submitted (2021) - -and references therein. diff --git a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/README.md b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/README.md new file mode 100644 index 0000000000..b8bee1b33f --- /dev/null +++ b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/README.md @@ -0,0 +1,7 @@ +# LG M50 Graphite negative electrode parameters + +Parameters for a LG M50 graphite negative electrode, from the paper + +> Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma Kendrick. ["Thermal-electrochemical parameters of a high energy lithium-ion cylindrical battery."](https://www.sciencedirect.com/science/article/pii/S0013468622008593) Electrochimica Acta 425 (2022): 140700 + +and references therein. diff --git a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/__init__.py b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/__init__.py similarity index 100% rename from pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/__init__.py rename to pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/__init__.py diff --git a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_diffusivity_ORegan2021.py b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_diffusivity_ORegan2022.py similarity index 83% rename from pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_diffusivity_ORegan2021.py rename to pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_diffusivity_ORegan2022.py index 12fb4b9508..693b527862 100644 --- a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_diffusivity_ORegan2021.py +++ b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_diffusivity_ORegan2022.py @@ -1,7 +1,7 @@ from pybamm import exp, constants -def graphite_LGM50_diffusivity_ORegan2021(sto, T): +def graphite_LGM50_diffusivity_ORegan2022(sto, T): """ LG M50 Graphite diffusivity as a function of stochiometry, in this case the diffusivity is taken to be a constant. The value is taken from [1]. @@ -9,9 +9,8 @@ def graphite_LGM50_diffusivity_ORegan2021(sto, T): References ---------- .. [1] Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma - Kendrick. "Thermal-electrochemical parametrisation of a lithium-ion battery: - mapping Li concentration and temperature dependencies." Journal of the - Electrochemical Society, submitted (2021). + Kendrick. "Thermal-electrochemical parameters of a high energy lithium-ion + cylindrical battery." Electrochimica Acta 425 (2022): 140700 Parameters ---------- diff --git a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_electrolyte_exchange_current_density_ORegan2021.py b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_electrolyte_exchange_current_density_ORegan2022.py similarity index 85% rename from pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_electrolyte_exchange_current_density_ORegan2021.py rename to pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_electrolyte_exchange_current_density_ORegan2022.py index c3d3c40af7..c66639eef6 100644 --- a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_electrolyte_exchange_current_density_ORegan2021.py +++ b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_electrolyte_exchange_current_density_ORegan2022.py @@ -1,7 +1,7 @@ from pybamm import exp, constants, Parameter -def graphite_LGM50_electrolyte_exchange_current_density_ORegan2021( +def graphite_LGM50_electrolyte_exchange_current_density_ORegan2022( c_e, c_s_surf, c_s_max, T ): """ @@ -11,9 +11,8 @@ def graphite_LGM50_electrolyte_exchange_current_density_ORegan2021( References ---------- .. [1] Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma - Kendrick. "Thermal-electrochemical parametrisation of a lithium-ion battery: - mapping Li concentration and temperature dependencies." Journal of the - Electrochemical Society, submitted (2021). + Kendrick. "Thermal-electrochemical parameters of a high energy lithium-ion + cylindrical battery." Electrochimica Acta 425 (2022): 140700 Parameters ---------- diff --git a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_entropic_change_ORegan2021.csv b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_entropic_change_ORegan2022.csv similarity index 100% rename from pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_entropic_change_ORegan2021.csv rename to pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_entropic_change_ORegan2022.csv diff --git a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_entropic_change_ORegan2021.py b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_entropic_change_ORegan2022.py similarity index 77% rename from pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_entropic_change_ORegan2021.py rename to pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_entropic_change_ORegan2022.py index c1a634de5a..de4a340052 100644 --- a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_entropic_change_ORegan2021.py +++ b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_entropic_change_ORegan2022.py @@ -1,7 +1,7 @@ from pybamm import exp, tanh -def graphite_LGM50_entropic_change_ORegan2021(sto, c_s_max): +def graphite_LGM50_entropic_change_ORegan2022(sto, c_s_max): """ LG M50 Graphite entropic change in open circuit potential (OCP) at a temperature of 298.15K as a function of the stochiometry. The fit is taken from [1]. @@ -9,9 +9,8 @@ def graphite_LGM50_entropic_change_ORegan2021(sto, c_s_max): References ---------- .. [1] Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma - Kendrick. "Thermal-electrochemical parametrisation of a lithium-ion battery: - mapping Li concentration and temperature dependencies." Journal of the - Electrochemical Society, submitted (2021). + Kendrick. "Thermal-electrochemical parameters of a high energy lithium-ion + cylindrical battery." Electrochimica Acta 425 (2022): 140700 Parameters ---------- diff --git a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_heat_capacity_ORegan2021.py b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_heat_capacity_ORegan2022.py similarity index 79% rename from pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_heat_capacity_ORegan2021.py rename to pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_heat_capacity_ORegan2022.py index e5aebec719..14c03bf1a2 100644 --- a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_heat_capacity_ORegan2021.py +++ b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_heat_capacity_ORegan2022.py @@ -1,7 +1,7 @@ from pybamm import Parameter -def graphite_LGM50_heat_capacity_ORegan2021(T): +def graphite_LGM50_heat_capacity_ORegan2022(T): """ Wet negative electrode specific heat capacity as a function of the temperature from [1]. @@ -9,9 +9,8 @@ def graphite_LGM50_heat_capacity_ORegan2021(T): References ---------- .. [1] Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma - Kendrick. "Thermal-electrochemical parametrisation of a lithium-ion battery: - mapping Li concentration and temperature dependencies." Journal of the - Electrochemical Society, submitted (2021). + Kendrick. "Thermal-electrochemical parameters of a high energy lithium-ion + cylindrical battery." Electrochimica Acta 425 (2022): 140700 Parameters ---------- diff --git a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_ocp_Chen2020.csv b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_ocp_Chen2020.csv similarity index 100% rename from pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_ocp_Chen2020.csv rename to pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_ocp_Chen2020.csv diff --git a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_ocp_Chen2020.py b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_ocp_Chen2020.py similarity index 100% rename from pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_ocp_Chen2020.py rename to pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_ocp_Chen2020.py diff --git a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_thermal_conductivity_ORegan2021.py b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_thermal_conductivity_ORegan2022.py similarity index 64% rename from pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_thermal_conductivity_ORegan2021.py rename to pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_thermal_conductivity_ORegan2022.py index aca11be3d7..23eb73a0f0 100644 --- a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/graphite_LGM50_thermal_conductivity_ORegan2021.py +++ b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/graphite_LGM50_thermal_conductivity_ORegan2022.py @@ -1,4 +1,4 @@ -def graphite_LGM50_thermal_conductivity_ORegan2021(T): +def graphite_LGM50_thermal_conductivity_ORegan2022(T): """ Wet negative electrode thermal conductivity as a function of the temperature from [1]. @@ -6,9 +6,8 @@ def graphite_LGM50_thermal_conductivity_ORegan2021(T): References ---------- .. [1] Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma - Kendrick. "Thermal-electrochemical parametrisation of a lithium-ion battery: - mapping Li concentration and temperature dependencies." Journal of the - Electrochemical Society, submitted (2021). + Kendrick. "Thermal-electrochemical parameters of a high energy lithium-ion + cylindrical battery." Electrochimica Acta 425 (2022): 140700 Parameters ---------- diff --git a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/parameters.csv b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/parameters.csv similarity index 80% rename from pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/parameters.csv rename to pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/parameters.csv index eed32431fc..b63056f0bd 100644 --- a/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/parameters.csv +++ b/pybamm/input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/parameters.csv @@ -4,7 +4,7 @@ Name [units],Value,Reference,Notes # Electrode properties,,, Negative electrode conductivity [S.m-1],215,Chen 2020,graphite Maximum concentration in negative electrode [mol.m-3],29583,Chen 2020, -Negative electrode diffusivity [m2.s-1],[function]graphite_LGM50_diffusivity_ORegan2021,O'Regan 2021, +Negative electrode diffusivity [m2.s-1],[function]graphite_LGM50_diffusivity_ORegan2022,O'Regan 2022, Negative electrode OCP [V],[function]graphite_LGM50_ocp_Chen2020,Chen 2020, ,,, # Microstructure,,, @@ -20,12 +20,12 @@ Negative electrode electrons in reaction,1,, Reference OCP vs SHE in the negative electrode [V],,, Negative electrode charge transfer coefficient,0.5,Chen 2020, Negative electrode double-layer capacity [F.m-2],0.2,, -Negative electrode exchange-current density [A.m-2],[function]graphite_LGM50_electrolyte_exchange_current_density_ORegan2021,O'Regan 2021, +Negative electrode exchange-current density [A.m-2],[function]graphite_LGM50_electrolyte_exchange_current_density_ORegan2022,O'Regan 2022, ,,, # Density,,, -Negative electrode density [kg.m-3],2060,O'Regan 2021,wet electrode +Negative electrode density [kg.m-3],2060,O'Regan 2022,wet electrode ,,, # Thermal parameters,,, -Negative electrode specific heat capacity [J.kg-1.K-1],[function]graphite_LGM50_heat_capacity_ORegan2021,O'Regan 2021,wet electrode -Negative electrode thermal conductivity [W.m-1.K-1],[function]graphite_LGM50_thermal_conductivity_ORegan2021,O'Regan 2021,wet electrode -Negative electrode OCP entropic change [V.K-1],[function]graphite_LGM50_entropic_change_ORegan2021,, \ No newline at end of file +Negative electrode specific heat capacity [J.kg-1.K-1],[function]graphite_LGM50_heat_capacity_ORegan2022,O'Regan 2022,wet electrode +Negative electrode thermal conductivity [W.m-1.K-1],[function]graphite_LGM50_thermal_conductivity_ORegan2022,O'Regan 2022,wet electrode +Negative electrode OCP entropic change [V.K-1],[function]graphite_LGM50_entropic_change_ORegan2022,, \ No newline at end of file diff --git a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/README.md b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/README.md deleted file mode 100644 index e85870fd2b..0000000000 --- a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# NMC 811 positive electrode parameters - -Parameters for an LG M50 NMC positive electrode, from the paper - -> Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma Kendrick. ["Thermal-electrochemical parametrisation of a lithium-ion battery: mapping Li concentration and temperature dependencies."]() Journal of the Electrochemical Society, submitted (2021) - -and references therein. diff --git a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/README.md b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/README.md new file mode 100644 index 0000000000..ba9aa6cdd4 --- /dev/null +++ b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/README.md @@ -0,0 +1,7 @@ +# NMC 811 positive electrode parameters + +Parameters for an LG M50 NMC positive electrode, from the paper + +> Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma Kendrick. ["Thermal-electrochemical parameters of a high energy lithium-ion cylindrical battery."](https://www.sciencedirect.com/science/article/pii/S0013468622008593) Electrochimica Acta 425 (2022): 140700 + +and references therein. diff --git a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/__init__.py b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/__init__.py similarity index 100% rename from pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/__init__.py rename to pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/__init__.py diff --git a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_diffusivity_ORegan2021.py b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_diffusivity_ORegan2022.py similarity index 81% rename from pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_diffusivity_ORegan2021.py rename to pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_diffusivity_ORegan2022.py index 35b664e07a..6ec0ca2fd6 100644 --- a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_diffusivity_ORegan2021.py +++ b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_diffusivity_ORegan2022.py @@ -1,7 +1,7 @@ from pybamm import exp, constants -def nmc_LGM50_diffusivity_ORegan2021(sto, T): +def nmc_LGM50_diffusivity_ORegan2022(sto, T): """ NMC diffusivity as a function of stoichiometry, in this case the diffusivity is taken to be a constant. The value is taken from [1]. @@ -9,9 +9,8 @@ def nmc_LGM50_diffusivity_ORegan2021(sto, T): References ---------- .. [1] Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma - Kendrick. "Thermal-electrochemical parametrisation of a lithium-ion battery: - mapping Li concentration and temperature dependencies." Journal of the - Electrochemical Society, submitted (2021). + Kendrick. "Thermal-electrochemical parameters of a high energy lithium-ion + cylindrical battery." Electrochimica Acta 425 (2022): 140700 Parameters ---------- diff --git a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_electrolyte_exchange_current_density_ORegan2021.py b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_electrolyte_exchange_current_density_ORegan2022.py similarity index 80% rename from pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_electrolyte_exchange_current_density_ORegan2021.py rename to pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_electrolyte_exchange_current_density_ORegan2022.py index caf90b3c2c..86612c32ae 100644 --- a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_electrolyte_exchange_current_density_ORegan2021.py +++ b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_electrolyte_exchange_current_density_ORegan2022.py @@ -1,7 +1,7 @@ from pybamm import exp, constants, Parameter -def nmc_LGM50_electrolyte_exchange_current_density_ORegan2021( +def nmc_LGM50_electrolyte_exchange_current_density_ORegan2022( c_e, c_s_surf, c_s_max, T ): """ @@ -11,9 +11,8 @@ def nmc_LGM50_electrolyte_exchange_current_density_ORegan2021( References ---------- .. [1] Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma - Kendrick. "Thermal-electrochemical parametrisation of a lithium-ion battery: - mapping Li concentration and temperature dependencies." Journal of the - Electrochemical Society, submitted (2021). + Kendrick. "Thermal-electrochemical parameters of a high energy lithium-ion + cylindrical battery." Electrochimica Acta 425 (2022): 140700 Parameters ---------- diff --git a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_electronic_conductivity_ORegan2021.py b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_electronic_conductivity_ORegan2022.py similarity index 68% rename from pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_electronic_conductivity_ORegan2021.py rename to pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_electronic_conductivity_ORegan2022.py index be99b5895d..22115666b7 100644 --- a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_electronic_conductivity_ORegan2021.py +++ b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_electronic_conductivity_ORegan2022.py @@ -1,7 +1,7 @@ from pybamm import exp, constants -def nmc_LGM50_electronic_conductivity_ORegan2021(T): +def nmc_LGM50_electronic_conductivity_ORegan2022(T): """ Positive electrode electronic conductivity as a function of the temperature from [1]. @@ -9,9 +9,8 @@ def nmc_LGM50_electronic_conductivity_ORegan2021(T): References ---------- .. [1] Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma - Kendrick. "Thermal-electrochemical parametrisation of a lithium-ion battery: - mapping Li concentration and temperature dependencies." Journal of the - Electrochemical Society, submitted (2021). + Kendrick. "Thermal-electrochemical parameters of a high energy lithium-ion + cylindrical battery." Electrochimica Acta 425 (2022): 140700 Parameters ---------- diff --git a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_entropic_change_ORegan2021.csv b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_entropic_change_ORegan2022.csv similarity index 100% rename from pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_entropic_change_ORegan2021.csv rename to pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_entropic_change_ORegan2022.csv diff --git a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_entropic_change_ORegan2021.py b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_entropic_change_ORegan2022.py similarity index 73% rename from pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_entropic_change_ORegan2021.py rename to pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_entropic_change_ORegan2022.py index 1f06012beb..96e06c0ec0 100644 --- a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_entropic_change_ORegan2021.py +++ b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_entropic_change_ORegan2022.py @@ -1,7 +1,7 @@ from pybamm import exp -def nmc_LGM50_entropic_change_ORegan2021(sto, c_s_max): +def nmc_LGM50_entropic_change_ORegan2022(sto, c_s_max): """ LG M50 NMC 811 entropic change in open circuit potential (OCP) at a temperature of 298.15K as a function of the stochiometry. The fit is taken from [1]. @@ -9,9 +9,8 @@ def nmc_LGM50_entropic_change_ORegan2021(sto, c_s_max): References ---------- .. [1] Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma - Kendrick. "Thermal-electrochemical parametrisation of a lithium-ion battery: - mapping Li concentration and temperature dependencies." Journal of the - Electrochemical Society, submitted (2021). + Kendrick. "Thermal-electrochemical parameters of a high energy lithium-ion + cylindrical battery." Electrochimica Acta 425 (2022): 140700 Parameters ---------- diff --git a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_heat_capacity_ORegan2021.py b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_heat_capacity_ORegan2022.py similarity index 80% rename from pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_heat_capacity_ORegan2021.py rename to pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_heat_capacity_ORegan2022.py index 33b06108e2..31449aa6bb 100644 --- a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_heat_capacity_ORegan2021.py +++ b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_heat_capacity_ORegan2022.py @@ -1,7 +1,7 @@ from pybamm import Parameter -def nmc_LGM50_heat_capacity_ORegan2021(T): +def nmc_LGM50_heat_capacity_ORegan2022(T): """ Wet positive electrode specific heat capacity as a function of the temperature from [1]. @@ -9,9 +9,8 @@ def nmc_LGM50_heat_capacity_ORegan2021(T): References ---------- .. [1] Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma - Kendrick. "Thermal-electrochemical parametrisation of a lithium-ion battery: - mapping Li concentration and temperature dependencies." Journal of the - Electrochemical Society, submitted (2021). + Kendrick. "Thermal-electrochemical parameters of a high energy lithium-ion + cylindrical battery." Electrochimica Acta 425 (2022): 140700 Parameters ---------- diff --git a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_ocp_Chen2020.csv b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_ocp_Chen2020.csv similarity index 100% rename from pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_ocp_Chen2020.csv rename to pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_ocp_Chen2020.csv diff --git a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_ocp_Chen2020.py b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_ocp_Chen2020.py similarity index 100% rename from pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_ocp_Chen2020.py rename to pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_ocp_Chen2020.py diff --git a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_thermal_conductivity_ORegan2021.py b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_thermal_conductivity_ORegan2022.py similarity index 65% rename from pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_thermal_conductivity_ORegan2021.py rename to pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_thermal_conductivity_ORegan2022.py index 49982db453..af7f60f661 100644 --- a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/nmc_LGM50_thermal_conductivity_ORegan2021.py +++ b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/nmc_LGM50_thermal_conductivity_ORegan2022.py @@ -1,4 +1,4 @@ -def nmc_LGM50_thermal_conductivity_ORegan2021(T): +def nmc_LGM50_thermal_conductivity_ORegan2022(T): """ Wet positive electrode thermal conductivity as a function of the temperature from [1]. @@ -6,9 +6,8 @@ def nmc_LGM50_thermal_conductivity_ORegan2021(T): References ---------- .. [1] Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma - Kendrick. "Thermal-electrochemical parametrisation of a lithium-ion battery: - mapping Li concentration and temperature dependencies." Journal of the - Electrochemical Society, submitted (2021). + Kendrick. "Thermal-electrochemical parameters of a high energy lithium-ion + cylindrical battery." Electrochimica Acta 425 (2022): 140700 Parameters ---------- diff --git a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/parameters.csv b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/parameters.csv similarity index 78% rename from pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/parameters.csv rename to pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/parameters.csv index 3f1fcda05d..977c044d58 100644 --- a/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/parameters.csv +++ b/pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/parameters.csv @@ -2,9 +2,9 @@ Name [units],Value,Reference,Notes # Empty rows and rows starting with ‘#’ will be ignored,,, ,,, # Electrode properties,,, -Positive electrode conductivity [S.m-1],[function]nmc_LGM50_electronic_conductivity_ORegan2021,O'Regan 2021, +Positive electrode conductivity [S.m-1],[function]nmc_LGM50_electronic_conductivity_ORegan2022,O'Regan 2022, Maximum concentration in positive electrode [mol.m-3],51765,Chen 2020, -Positive electrode diffusivity [m2.s-1],[function]nmc_LGM50_diffusivity_ORegan2021,O'Regan 2021, +Positive electrode diffusivity [m2.s-1],[function]nmc_LGM50_diffusivity_ORegan2022,O'Regan 2022, Positive electrode OCP [V],[function]nmc_LGM50_ocp_Chen2020,Chen 2020, ,,, # Microstructure,,, @@ -20,12 +20,12 @@ Positive electrode electrons in reaction,1,, Reference OCP vs SHE in the positive electrode [V],,, Positive electrode charge transfer coefficient,0.5,Chen 2020, Positive electrode double-layer capacity [F.m-2],0.2,, -Positive electrode exchange-current density [A.m-2],[function]nmc_LGM50_electrolyte_exchange_current_density_ORegan2021,O'Regan 2021, +Positive electrode exchange-current density [A.m-2],[function]nmc_LGM50_electrolyte_exchange_current_density_ORegan2022,O'Regan 2022, ,,, # Density,,, -Positive electrode density [kg.m-3],3699,O'Regan 2021,wet electrode +Positive electrode density [kg.m-3],3699,O'Regan 2022,wet electrode ,,, # Thermal parameters,,, -Positive electrode specific heat capacity [J.kg-1.K-1],[function]nmc_LGM50_heat_capacity_ORegan2021,O'Regan 2021,wet electrode -Positive electrode thermal conductivity [W.m-1.K-1],[function]nmc_LGM50_thermal_conductivity_ORegan2021,O'Regan 2021,wet electrode -Positive electrode OCP entropic change [V.K-1],[function]nmc_LGM50_entropic_change_ORegan2021,, \ No newline at end of file +Positive electrode specific heat capacity [J.kg-1.K-1],[function]nmc_LGM50_heat_capacity_ORegan2022,O'Regan 2022,wet electrode +Positive electrode thermal conductivity [W.m-1.K-1],[function]nmc_LGM50_thermal_conductivity_ORegan2022,O'Regan 2022,wet electrode +Positive electrode OCP entropic change [V.K-1],[function]nmc_LGM50_entropic_change_ORegan2022,, \ No newline at end of file diff --git a/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2021/README.md b/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2021/README.md deleted file mode 100644 index a35564f71a..0000000000 --- a/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2021/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Separator parameters - -Parameters for an LG M50 separator, from the paper - -> Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma Kendrick. ["Thermal-electrochemical parametrisation of a lithium-ion battery: mapping Li concentration and temperature dependencies."]() Journal of the Electrochemical Society, submitted (2021) - -and references therein. diff --git a/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2022/README.md b/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2022/README.md new file mode 100644 index 0000000000..186c8c5cf6 --- /dev/null +++ b/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2022/README.md @@ -0,0 +1,7 @@ +# Separator parameters + +Parameters for an LG M50 separator, from the paper + +> Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma Kendrick. ["Thermal-electrochemical parameters of a high energy lithium-ion cylindrical battery."](https://www.sciencedirect.com/science/article/pii/S0013468622008593) Electrochimica Acta 425 (2022): 140700 + +and references therein. diff --git a/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2021/__init__.py b/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2022/__init__.py similarity index 100% rename from pybamm/input/parameters/lithium_ion/separators/separator_ORegan2021/__init__.py rename to pybamm/input/parameters/lithium_ion/separators/separator_ORegan2022/__init__.py diff --git a/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2021/parameters.csv b/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2022/parameters.csv similarity index 67% rename from pybamm/input/parameters/lithium_ion/separators/separator_ORegan2021/parameters.csv rename to pybamm/input/parameters/lithium_ion/separators/separator_ORegan2022/parameters.csv index bf8b51d40b..729b6a3a55 100644 --- a/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2021/parameters.csv +++ b/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2022/parameters.csv @@ -4,6 +4,6 @@ Name [units],Value,Reference,Notes Separator porosity,0.47,Chen 2020, Separator Bruggeman coefficient (electrolyte),1.5,Chen 2020,theoretical Separator Bruggeman coefficient (electrode),1.5,default, -Separator density [kg.m-3],1548,O'Regan 2021, -Separator specific heat capacity [J.kg-1.K-1],[function]separator_LGM50_heat_capacity_ORegan2021,O'Regan 2021, -Separator thermal conductivity [W.m-1.K-1],0.3344,O'Regan 2021, \ No newline at end of file +Separator density [kg.m-3],1548,O'Regan 2022, +Separator specific heat capacity [J.kg-1.K-1],[function]separator_LGM50_heat_capacity_ORegan2022,O'Regan 2022, +Separator thermal conductivity [W.m-1.K-1],0.3344,O'Regan 2022, \ No newline at end of file diff --git a/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2021/separator_LGM50_heat_capacity_ORegan2021.py b/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2022/separator_LGM50_heat_capacity_ORegan2022.py similarity index 79% rename from pybamm/input/parameters/lithium_ion/separators/separator_ORegan2021/separator_LGM50_heat_capacity_ORegan2021.py rename to pybamm/input/parameters/lithium_ion/separators/separator_ORegan2022/separator_LGM50_heat_capacity_ORegan2022.py index e7620c418d..f5a258a68c 100644 --- a/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2021/separator_LGM50_heat_capacity_ORegan2021.py +++ b/pybamm/input/parameters/lithium_ion/separators/separator_ORegan2022/separator_LGM50_heat_capacity_ORegan2022.py @@ -1,16 +1,15 @@ from pybamm import Parameter -def separator_LGM50_heat_capacity_ORegan2021(T): +def separator_LGM50_heat_capacity_ORegan2022(T): """ Wet separator specific heat capacity as a function of the temperature from [1]. References ---------- .. [1] Kieran O’Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma - Kendrick. "Thermal-electrochemical parametrisation of a lithium-ion battery: - mapping Li concentration and temperature dependencies." Journal of the - Electrochemical Society, submitted (2021). + Kendrick. "Thermal-electrochemical parameters of a high energy lithium-ion + cylindrical battery." Electrochimica Acta 425 (2022): 140700 Parameters ---------- diff --git a/pybamm/models/full_battery_models/base_battery_model.py b/pybamm/models/full_battery_models/base_battery_model.py index 415bc2d0d3..2edd3efa8a 100644 --- a/pybamm/models/full_battery_models/base_battery_model.py +++ b/pybamm/models/full_battery_models/base_battery_model.py @@ -68,6 +68,9 @@ class BatteryModelOptions(pybamm.FuzzyDict): * "lithium plating" : str Sets the model for lithium plating. Can be "none" (default), "reversible", "partially reversible", or "irreversible". + * "lithium plating porosity change" : str + Whether to include porosity change due to lithium plating, can be + "false" (default) or "true". * "loss of active material" : str Sets the model for loss of active material. Can be "none" (default), "stress-driven", "reaction-driven", or "stress and reaction-driven". @@ -166,6 +169,11 @@ class BatteryModelOptions(pybamm.FuzzyDict): Which electrode(s) intercalates and which is counter. If "both" (default), the model is a standard battery. Otherwise can be "negative" or "positive" to indicate a half-cell model. + * "x-average side reactions": str + Whether to average the side reactions (SEI growth, lithium plating and + the respective porosity change) over the x-axis in Single Particle + Models, can be "false" or "true". Default is "false" for SPMe and + "true" for SPM. **Extends:** :class:`dict` """ @@ -248,6 +256,7 @@ def __init__(self, extra_options): "thermal": ["isothermal", "lumped", "x-lumped", "x-full"], "total interfacial current density as a state": ["false", "true"], "working electrode": ["both", "negative", "positive"], + "x-average side reactions": ["false", "true"], } default_options = { @@ -649,6 +658,13 @@ def options(self, extra_options): options["electrolyte conductivity"] ) ) + if isinstance(self, pybamm.lithium_ion.SPM) and not isinstance( + self, pybamm.lithium_ion.SPMe + ): + if options["x-average side reactions"] == "false": + raise pybamm.OptionError( + "x-average side reactions cannot be 'false' for SPM models" + ) if isinstance(self, pybamm.lead_acid.BaseModel): if options["thermal"] != "isothermal" and options["dimensionality"] != 0: raise pybamm.OptionError( diff --git a/pybamm/models/full_battery_models/lithium_ion/base_lithium_ion_model.py b/pybamm/models/full_battery_models/lithium_ion/base_lithium_ion_model.py index cc91f46ced..f1faae781f 100644 --- a/pybamm/models/full_battery_models/lithium_ion/base_lithium_ion_model.py +++ b/pybamm/models/full_battery_models/lithium_ion/base_lithium_ion_model.py @@ -227,7 +227,7 @@ def set_open_circuit_potential_submodel(self): def set_sei_submodel(self): if self.half_cell: reaction_loc = "interface" - elif self.x_average: + elif self.options["x-average side reactions"] == "true": reaction_loc = "x-average" else: reaction_loc = "full electrode" @@ -247,8 +247,9 @@ def set_lithium_plating_submodel(self): self.param, self.options ) else: + x_average = (self.options["x-average side reactions"] == "true") self.submodels["lithium plating"] = pybamm.lithium_plating.Plating( - self.param, self.x_average, self.options + self.param, x_average, self.options ) def set_total_kinetics_submodel(self): @@ -298,8 +299,9 @@ def set_porosity_submodel(self): self.options["SEI porosity change"] == "true" or self.options["lithium plating porosity change"] == "true" ): + x_average = (self.options["x-average side reactions"] == "true") self.submodels["porosity"] = pybamm.porosity.ReactionDriven( - self.param, self.options, self.x_average + self.param, self.options, x_average ) def set_li_metal_counter_electrode_submodels(self): diff --git a/pybamm/models/full_battery_models/lithium_ion/spm.py b/pybamm/models/full_battery_models/lithium_ion/spm.py index bbbce66d52..0696091cdd 100644 --- a/pybamm/models/full_battery_models/lithium_ion/spm.py +++ b/pybamm/models/full_battery_models/lithium_ion/spm.py @@ -45,10 +45,18 @@ def __init__(self, options=None, name="Single Particle Model", build=True): if kinetics is not None and surface_form is None: options["surface form"] = "algebraic" - # For degradation models we use the "x-average" form since this is a - # reduced-order model with uniform current density in the electrodes + # For degradation models we use the "x-average", note that for side reactions + # this is set by "x-average side reactions" self.x_average = True + # Set "x-average side reactions" to "true" if the model is SPM + x_average_side_reactions = options.get("x-average side reactions") + if ( + x_average_side_reactions is None + and self.__class__ in [pybamm.lithium_ion.SPM, pybamm.lithium_ion.MPM] + ): + options["x-average side reactions"] = "true" + super().__init__(options, name) self.set_submodels(build) @@ -56,6 +64,12 @@ def __init__(self, options=None, name="Single Particle Model", build=True): if self.__class__ != "MPM": pybamm.citations.register("Marquis2019") + if ( + self.options["SEI"] not in ["none", "constant"] + or self.options["lithium plating"] != "none" + ): + pybamm.citations.register("BrosaPlanella2022") + def set_convection_submodel(self): self.submodels[ diff --git a/pybamm/models/full_battery_models/lithium_ion/spme.py b/pybamm/models/full_battery_models/lithium_ion/spme.py index 4990ee28ff..6f4966a987 100644 --- a/pybamm/models/full_battery_models/lithium_ion/spme.py +++ b/pybamm/models/full_battery_models/lithium_ion/spme.py @@ -41,8 +41,8 @@ class SPMe(SPM): def __init__( self, options=None, name="Single Particle Model with electrolyte", build=True ): - # For degradation models we use the "x-average" form since this is a - # reduced-order model with uniform current density in the electrodes + # For degradation models we use the "x-average", note that for side reactions + # this is overwritten by "x-average side reactions" self.x_average = True # Initialize with the SPM diff --git a/pybamm/parameters/parameter_sets.py b/pybamm/parameters/parameter_sets.py index 93bd171f9d..4ddad8b194 100644 --- a/pybamm/parameters/parameter_sets.py +++ b/pybamm/parameters/parameter_sets.py @@ -76,15 +76,15 @@ Offer, and Monica Marinescu. Lithium-ion battery degradation: how to model it. Phys. Chem. Chem. Phys., 24:7909-7922, 2022. URL: http://dx.doi.org/10.1039/D2CP00417H, doi:10.1039/D2CP00417H. - * ORegan2021 : + * ORegan2022 : - Chang-Hui Chen, Ferran Brosa Planella, Kieran O'Regan, Dominika Gastol, W. Dhammika Widanage, and Emma Kendrick. Development of Experimental Techniques for Parameterization of Multi-scale Lithium-ion Battery Models. Journal of The Electrochemical Society, 167(8):080534, 2020. doi:10.1149/1945-7111/ab9050. - Kieran O'Regan, Ferran Brosa Planella, W. Dhammika Widanage, and Emma Kendrick. - Thermal-electrochemical parametrisation of a lithium-ion battery: mapping Li - concentration and temperature dependencies. Journal of The Electrochemical - Society, ():, 2021. doi:. + Thermal-electrochemical parameters of a high energy lithium-ion cylindrical + battery. Electrochimica Acta, 425: 140700, 2022. + doi: 10.1016/j.electacta.2022.140700. * Prada2013 : - Chang-Hui Chen, Ferran Brosa Planella, Kieran O'Regan, Dominika Gastol, W. Dhammika Widanage, and Emma Kendrick. Development of Experimental Techniques @@ -240,15 +240,15 @@ "citation": "Xu2019", } -ORegan2021 = { +ORegan2022 = { "chemistry": "lithium_ion", - "cell": "LGM50_ORegan2021", - "negative electrode": "graphite_ORegan2021", - "separator": "separator_ORegan2021", - "positive electrode": "nmc_ORegan2021", + "cell": "LGM50_ORegan2022", + "negative electrode": "graphite_ORegan2022", + "separator": "separator_ORegan2022", + "positive electrode": "nmc_ORegan2022", "electrolyte": "lipf6_EC_EMC_3_7_Landesfeind2019", - "experiment": "1C_discharge_from_full_ORegan2021", - "citation": ["ORegan2021", "Chen2020"], + "experiment": "1C_discharge_from_full_ORegan2022", + "citation": ["ORegan2022", "Chen2020"], } OKane2022 = { diff --git a/tests/unit/test_citations.py b/tests/unit/test_citations.py index 0473b76948..c7c4fa178a 100644 --- a/tests/unit/test_citations.py +++ b/tests/unit/test_citations.py @@ -143,6 +143,36 @@ def test_brosaplanella_2021(self): pybamm.electrolyte_conductivity.Integrated(None) self.assertIn("BrosaPlanella2021", citations._papers_to_cite) + def test_brosaplanella_2022(self): + # Test that calling relevant bits of code adds the right paper to citations + citations = pybamm.citations + + citations._reset() + self.assertNotIn("BrosaPlanella2022", citations._papers_to_cite) + pybamm.lithium_ion.SPM(build=False, options={"SEI": "none"}) + pybamm.lithium_ion.SPM(build=False, options={"SEI": "constant"}) + pybamm.lithium_ion.SPMe(build=False, options={"SEI": "none"}) + pybamm.lithium_ion.SPMe(build=False, options={"SEI": "constant"}) + self.assertNotIn("BrosaPlanella2022", citations._papers_to_cite) + + pybamm.lithium_ion.SPM(build=False, options={"SEI": "ec reaction limited"}) + self.assertIn("BrosaPlanella2022", citations._papers_to_cite) + citations._reset() + + pybamm.lithium_ion.SPMe(build=False, options={"SEI": "ec reaction limited"}) + self.assertIn("BrosaPlanella2022", citations._papers_to_cite) + citations._reset() + + pybamm.lithium_ion.SPM(build=False, options={"lithium plating": "irreversible"}) + self.assertIn("BrosaPlanella2022", citations._papers_to_cite) + citations._reset() + + pybamm.lithium_ion.SPMe( + build=False, options={"lithium plating": "irreversible"} + ) + self.assertIn("BrosaPlanella2022", 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 @@ -228,8 +258,8 @@ def test_parameter_citations(self): self.assertIn("Richardson2020", citations._papers_to_cite) citations._reset() - pybamm.ParameterValues("ORegan2021") - self.assertIn("ORegan2021", citations._papers_to_cite) + pybamm.ParameterValues("ORegan2022") + self.assertIn("ORegan2022", citations._papers_to_cite) def test_solver_citations(self): # Test that solving each solver adds the right citations diff --git a/tests/unit/test_models/test_full_battery_models/test_base_battery_model.py b/tests/unit/test_models/test_full_battery_models/test_base_battery_model.py index fe62d5a73b..e7e4f8a171 100644 --- a/tests/unit/test_models/test_full_battery_models/test_base_battery_model.py +++ b/tests/unit/test_models/test_full_battery_models/test_base_battery_model.py @@ -40,6 +40,7 @@ 'thermal': 'x-full' (possible: ['isothermal', 'lumped', 'x-lumped', 'x-full']) 'total interfacial current density as a state': 'false' (possible: ['false', 'true']) 'working electrode': 'both' (possible: ['both', 'negative', 'positive']) +'x-average side reactions': 'false' (possible: ['false', 'true']) 'external submodels': [] 'timescale': 'default' """ # noqa: E501 diff --git a/tests/unit/test_models/test_full_battery_models/test_lithium_ion/test_spm.py b/tests/unit/test_models/test_full_battery_models/test_lithium_ion/test_spm.py index 360b75c48f..e439c21f1b 100644 --- a/tests/unit/test_models/test_full_battery_models/test_lithium_ion/test_spm.py +++ b/tests/unit/test_models/test_full_battery_models/test_lithium_ion/test_spm.py @@ -23,6 +23,22 @@ def test_kinetics_options(self): with self.assertRaisesRegex(pybamm.OptionError, "Inverse kinetics"): pybamm.lithium_ion.SPM(options) + def test_x_average_options(self): + # Check model with x-averaged side reactions + options = { + "lithium plating": "irreversible", + "lithium plating porosity change": "true", + "SEI": "ec reaction limited", + "SEI porosity change": "true", + "x-average side reactions": "true", + } + self.check_well_posedness(options) + + # Check model with distributed side reactions throws an error + options["x-average side reactions"] = "false" + with self.assertRaisesRegex(pybamm.OptionError, "cannot be 'false' for SPM"): + pybamm.lithium_ion.SPM(options) + def test_new_model(self): model = pybamm.lithium_ion.SPM({"thermal": "x-full"}) new_model = model.new_copy() diff --git a/tests/unit/test_parameters/test_parameter_sets/test_LGM50_ORegan2021.py b/tests/unit/test_parameters/test_parameter_sets/test_LGM50_ORegan2022.py similarity index 81% rename from tests/unit/test_parameters/test_parameter_sets/test_LGM50_ORegan2021.py rename to tests/unit/test_parameters/test_parameter_sets/test_LGM50_ORegan2022.py index fba9b6667c..87d7986b47 100644 --- a/tests/unit/test_parameters/test_parameter_sets/test_LGM50_ORegan2021.py +++ b/tests/unit/test_parameters/test_parameter_sets/test_LGM50_ORegan2022.py @@ -6,28 +6,28 @@ import os -class TestORegan2021(unittest.TestCase): +class TestORegan2022(unittest.TestCase): def test_load_params(self): negative_electrode = pybamm.ParameterValues({}).read_parameters_csv( pybamm.get_parameters_filepath( - "input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2021/" + "input/parameters/lithium_ion/negative_electrodes/graphite_ORegan2022/" "parameters.csv" ) ) self.assertEqual( negative_electrode["Negative electrode diffusivity [m2.s-1]"], - "[function]graphite_LGM50_diffusivity_ORegan2021", + "[function]graphite_LGM50_diffusivity_ORegan2022", ) positive_electrode = pybamm.ParameterValues({}).read_parameters_csv( pybamm.get_parameters_filepath( - "input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/" + "input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/" "parameters.csv" ) ) self.assertEqual( positive_electrode["Positive electrode conductivity [S.m-1]"], - "[function]nmc_LGM50_electronic_conductivity_ORegan2021", + "[function]nmc_LGM50_electronic_conductivity_ORegan2022", ) electrolyte = pybamm.ParameterValues({}).read_parameters_csv( @@ -42,7 +42,7 @@ def test_load_params(self): cell = pybamm.ParameterValues({}).read_parameters_csv( pybamm.get_parameters_filepath( - "input/parameters/lithium_ion/cells/LGM50_ORegan2021/parameters.csv" + "input/parameters/lithium_ion/cells/LGM50_ORegan2022/parameters.csv" ) ) self.assertEqual( @@ -52,25 +52,25 @@ def test_load_params(self): def test_functions(self): root = pybamm.root_dir() - param = pybamm.ParameterValues("ORegan2021") + param = pybamm.ParameterValues("ORegan2022") T = pybamm.Scalar(298.15) # Positive electrode - p = "pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2021/" + p = "pybamm/input/parameters/lithium_ion/positive_electrodes/nmc_ORegan2022/" k_path = os.path.join(root, p) c_p_max = param["Maximum concentration in positive electrode [mol.m-3]"] fun_test = { - "nmc_LGM50_entropic_change_ORegan2021.py": ([0.5, c_p_max], -9.7940e-07), - "nmc_LGM50_heat_capacity_ORegan2021.py": ([298.15], 902.6502), - "nmc_LGM50_diffusivity_ORegan2021.py": ([0.5, 298.15], 7.2627e-15), - "nmc_LGM50_electrolyte_exchange_current_density_ORegan2021.py": ( + "nmc_LGM50_entropic_change_ORegan2022.py": ([0.5, c_p_max], -9.7940e-07), + "nmc_LGM50_heat_capacity_ORegan2022.py": ([298.15], 902.6502), + "nmc_LGM50_diffusivity_ORegan2022.py": ([0.5, 298.15], 7.2627e-15), + "nmc_LGM50_electrolyte_exchange_current_density_ORegan2022.py": ( [1e3, 1e4, c_p_max, 298.15], 2.1939, ), "nmc_LGM50_ocp_Chen2020.py": ([0.5], 3.9720), - "nmc_LGM50_electronic_conductivity_ORegan2021.py": ([298.15], 0.8473), - "nmc_LGM50_thermal_conductivity_ORegan2021.py": ([T], 0.8047), + "nmc_LGM50_electronic_conductivity_ORegan2022.py": ([298.15], 0.8473), + "nmc_LGM50_thermal_conductivity_ORegan2022.py": ([T], 0.8047), } for name, value in fun_test.items(): @@ -80,24 +80,24 @@ def test_functions(self): # Negative electrode p = ( "pybamm/input/parameters/lithium_ion/negative_electrodes/" - "graphite_ORegan2021/" + "graphite_ORegan2022/" ) k_path = os.path.join(root, p) c_n_max = param["Maximum concentration in negative electrode [mol.m-3]"] fun_test = { - "graphite_LGM50_entropic_change_ORegan2021.py": ( + "graphite_LGM50_entropic_change_ORegan2022.py": ( [0.5, c_n_max], -2.6460e-07, ), - "graphite_LGM50_heat_capacity_ORegan2021.py": ([298.15], 847.7155), - "graphite_LGM50_diffusivity_ORegan2021.py": ([0.5, 298.15], 2.8655e-16), - "graphite_LGM50_electrolyte_exchange_current_density_ORegan2021.py": ( + "graphite_LGM50_heat_capacity_ORegan2022.py": ([298.15], 847.7155), + "graphite_LGM50_diffusivity_ORegan2022.py": ([0.5, 298.15], 2.8655e-16), + "graphite_LGM50_electrolyte_exchange_current_density_ORegan2022.py": ( [1e3, 1e4, c_n_max, 298.15], 1.0372, ), "graphite_LGM50_ocp_Chen2020.py": ([0.5], 0.1331), - "graphite_LGM50_thermal_conductivity_ORegan2021.py": ([T], 3.7695), + "graphite_LGM50_thermal_conductivity_ORegan2022.py": ([T], 3.7695), } for name, value in fun_test.items(): @@ -105,7 +105,7 @@ def test_functions(self): self.assertAlmostEqual(param.evaluate(fun(*value[0])), value[1], places=4) # Cells - p = "pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2021/" + p = "pybamm/input/parameters/lithium_ion/cells/LGM50_ORegan2022/" k_path = os.path.join(root, p) fun_test = { @@ -119,11 +119,11 @@ def test_functions(self): self.assertAlmostEqual(param.evaluate(fun(*value[0])), value[1], places=4) # Separator - p = "pybamm/input/parameters/lithium_ion/separators/separator_ORegan2021/" + p = "pybamm/input/parameters/lithium_ion/separators/separator_ORegan2022/" k_path = os.path.join(root, p) fun_test = { - "separator_LGM50_heat_capacity_ORegan2021.py": ([298.15], 1130.9656), + "separator_LGM50_heat_capacity_ORegan2022.py": ([298.15], 1130.9656), } for name, value in fun_test.items(): @@ -132,7 +132,7 @@ def test_functions(self): def test_standard_lithium_parameters(self): - parameter_values = pybamm.ParameterValues("ORegan2021") + parameter_values = pybamm.ParameterValues("ORegan2022") model = pybamm.lithium_ion.DFN() sim = pybamm.Simulation(model, parameter_values=parameter_values)