pybop.models.lithium_ion#

Submodules#

Classes#

`GroupedSPM`	A grouped parameter version of the single particle model (SPM).
`GroupedSPMe`	A grouped parameter version of the single particle model with electrolyte (SPMe).
`SPDiffusion`	Diffusion model for a single, spherical particle representing a half-cell for GITT.
`WeppnerHuggins`	Represents the Weppner & Huggins model to fit diffusion coefficients to GITT data.

Package Contents#

class pybop.models.lithium_ion.GroupedSPM(name='Grouped Single Particle Model', **model_kwargs)[source]#

Bases: pybamm.lithium_ion.BaseModel

A grouped parameter version of the single particle model (SPM).

Parameters:

name (str, optional) – The name of the model.
**model_kwargs (optional) –
Valid PyBaMM model option keys and their values, for example: options : dict, optional

A dictionary of options to customise the behaviour of the PyBaMM model.

buildbool, optional
If True, the model is built upon creation (default: False).

U(sto, domain)[source]#: Dimensional open-circuit potential [V], calculated as U(x) = U_ref(x). Credit: PyBaMM

build_model()[source]#: Build model variables and equations Credit: PyBaMM

static create_grouped_parameters(parameter_values: pybamm.ParameterValues) → pybamm.ParameterValues[source]#

Create a parameter set for the Grouped Single Particle Model with Electrolyte from a PyBaMM lithium-ion ParameterValues object.

Parameters:: parameter_values (pybamm.ParameterValues) – Parameters and their corresponding values.
Returns:: parameter_values – A new set of parameters and their values.
Return type:: pybamm.ParameterValues

property default_geometry#: Returns a dictionary of the default geometry for the model, which is empty by default.

property default_parameter_values: pybamm.ParameterValues#: Returns the default parameter values for the model (an empty set of parameters by default).

property default_quick_plot_variables#: Returns the default variables for quick plotting (None by default).

property default_spatial_methods#: Returns a dictionary of the default spatial methods for the model, which is empty by default.

property default_submesh_types#: Returns a dictionary of the default submesh types for the model, which is empty by default.

property default_var_pts#: Returns a dictionary of the default variable points for the model, which is empty by default.

variables#: Returns a dictionary mapping strings to expressions representing the model’s useful variables.

class pybop.models.lithium_ion.GroupedSPMe(name='Grouped Single Particle Model with Electrolyte', **model_kwargs)[source]#

Bases: pybamm.lithium_ion.BaseModel

A grouped parameter version of the single particle model with electrolyte (SPMe).

Parameters:

name (str, optional) – The name of the model.
**model_kwargs (optional) –
Valid PyBaMM model option keys and their values, for example: options : dict, optional

A dictionary of options to customise the behaviour of the PyBaMM model.

buildbool, optional
If True, the model is built upon creation (default: False).

U(sto, domain)[source]#: Dimensional open-circuit potential [V], calculated as U(x) = U_ref(x). Credit: PyBaMM

build_model()[source]#: Build model variables and equations Credit: PyBaMM

static create_grouped_parameters(parameter_values: pybamm.ParameterValues) → pybamm.ParameterValues[source]#

Create a parameter set for the Grouped Single Particle Model with Electrolyte from a PyBaMM lithium-ion ParameterValues object.

Parameters:: parameter_values (pybamm.ParameterValues) – Parameters and their corresponding values.
Returns:: parameter_values – A new set of parameters and their values.
Return type:: pybamm.ParameterValues

property default_geometry#: Returns a dictionary of the default geometry for the model, which is empty by default.

property default_parameter_values: pybamm.ParameterValues#: Returns the default parameter values for the model (an empty set of parameters by default).

property default_quick_plot_variables#: Returns the default variables for quick plotting (None by default).

property default_spatial_methods#: Returns a dictionary of the default spatial methods for the model, which is empty by default.

property default_submesh_types#: Returns a dictionary of the default submesh types for the model, which is empty by default.

property default_var_pts#: Returns a dictionary of the default variable points for the model, which is empty by default.

variables#: Returns a dictionary mapping strings to expressions representing the model’s useful variables.

class pybop.models.lithium_ion.SPDiffusion(name='Single Particle Diffusion Model', **model_kwargs)[source]#

Bases: pybamm.lithium_ion.BaseModel

Diffusion model for a single, spherical particle representing a half-cell for GITT.

Note: the working electrode is the positive electrode.

Parameters:

name (str, optional) – The name of the model.
**model_kwargs (optional) –
Valid PyBaMM model option keys and their values, for example: options : dict, optional

A dictionary of options to customise the behaviour of the PyBaMM model.

buildbool, optional
If True, the model is built upon creation (default: False).

R0(sto)[source]#: Series resistance [Ohm].

U(sto)[source]#: Dimensional open-circuit potential [V], calculated as U(x) = U_ref(x). Credit: PyBaMM

build_model()[source]#: Build model variables and equations Credit: PyBaMM

static create_grouped_parameters(parameter_values: pybamm.ParameterValues) → pybamm.ParameterValues[source]#

Create a parameter set for the Single Particle Diffusion Model from a PyBaMM lithium-ion ParameterValues object.

Note: the working electrode is the positive electrode.

Parameters:: parameter_values (pybamm.ParameterValues) – Parameters and their corresponding values.
Returns:: parameter_values – A new set of parameters and their values.
Return type:: pybamm.ParameterValues

tau_d(sto)[source]#: Diffusion time scale [s] for lithium in the particles.

property default_geometry#: Returns a dictionary of the default geometry for the model, which is empty by default.

property default_parameter_values: pybamm.ParameterValues#: Returns the default parameter values for the model (an empty set of parameters by default).

property default_quick_plot_variables#: Returns the default variables for quick plotting (None by default).

property default_spatial_methods#: Returns a dictionary of the default spatial methods for the model, which is empty by default.

property default_submesh_types#: Returns a dictionary of the default submesh types for the model, which is empty by default.

property default_var_pts#: Returns a dictionary of the default variable points for the model, which is empty by default.

variables#: Returns a dictionary mapping strings to expressions representing the model’s useful variables.

class pybop.models.lithium_ion.WeppnerHuggins(name='Weppner & Huggins model', **model_kwargs)[source]#

Bases: pybamm.lithium_ion.BaseModel

Represents the Weppner & Huggins model to fit diffusion coefficients to GITT data.

Note: the working electrode is the positive electrode.

Parameters:

name (str, optional) – The name of the model.
**model_kwargs (optional) –
Valid PyBaMM model option keys and their values, for example: options : dict, optional

A dictionary of options to customise the behaviour of the PyBaMM model.

buildbool, optional
If True, the model is built upon creation (default: False).

static create_grouped_parameters(parameter_values: pybamm.ParameterValues) → pybamm.ParameterValues[source]#

Create a parameter set for the Weppner & Huggins model from a PyBaMM lithium-ion ParameterValues object.

Note: the working electrode is the positive electrode.

Parameters:: parameter_values (pybamm.ParameterValues) – Parameters and their corresponding values.
Returns:: parameter_values – A new set of parameters and their values.
Return type:: pybamm.ParameterValues

_built = True#

_summary_variables = []#

property default_geometry#: Returns a dictionary of the default geometry for the model, which is empty by default.

property default_parameter_values: pybamm.ParameterValues#: Returns the default parameter values for the model (an empty set of parameters by default).

property default_quick_plot_variables#: Returns the default variables for quick plotting (None by default).

property default_solver#: Returns the default solver for the model, based on whether it is an ODE/DAE or algebraic model.

property default_spatial_methods#: Returns a dictionary of the default spatial methods for the model, which is empty by default.

property default_submesh_types#: Returns a dictionary of the default submesh types for the model, which is empty by default.

property default_var_pts#: Returns a dictionary of the default variable points for the model, which is empty by default.

variables#: Returns a dictionary mapping strings to expressions representing the model’s useful variables.