pybop.models.lithium_ion.basic_SPMe

Classes

BaseGroupedSPMe

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

Functions

convert_physical_to_grouped_parameters(parameter_set)

A function to create a grouped SPMe parameter set from a standard

Module Contents

class pybop.models.lithium_ion.basic_SPMe.BaseGroupedSPMe(name='Grouped Single Particle Model with Electrolyte', **model_kwargs)

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.

U(sto, domain)

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

build_model()

Build model variables and equations Credit: PyBaMM

property default_parameter_values

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).

variables

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

pybop.models.lithium_ion.basic_SPMe.convert_physical_to_grouped_parameters(parameter_set)

A function to create a grouped SPMe parameter set from a standard PyBaMM parameter set.

Parameters:

parameter_set (Union[dict, pybop.ParameterSet, pybamm.ParameterValues]) – A dict-like object containing the parameter values.

Returns:

A dictionary of the grouped parameters.

Return type:

dict