pybop.models.lithium_ion.grouped_spme#

Classes#

GroupedSPMe

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

Functions#

set_initial_state(initial_value, parameter_values[, ...])

Set the value of the initial state of charge.

Module Contents#

class pybop.models.lithium_ion.grouped_spme.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[source]#

Returns a dictionary of the default geometry for the model, which is empty by default.

property default_parameter_values: pybamm.ParameterValues[source]#

Returns the default parameter values for the model (an empty set of parameters by default).

property default_quick_plot_variables[source]#

Returns the default variables for quick plotting (None by default).

property default_spatial_methods[source]#

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

property default_submesh_types[source]#

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

property default_var_pts[source]#

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

variables[source]#

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

pybop.models.lithium_ion.grouped_spme.set_initial_state(initial_value, parameter_values, direction=None, param=None, inplace=True, options=None, inputs=None, tol=1e-06)[source]#

Set the value of the initial state of charge.

Parameters:

  • initial_value (float) – Target initial value. If float, interpreted as SOC, must be between 0 and 1. If string e.g. “4 V”, interpreted as voltage, must be between V_min and V_max.

  • parameter_values (pybamm.ParameterValues) – Parameters and their corresponding values.

  • param (pybamm.LithiumIonParameters, optional) – The symbolic parameter set to use for the simulation. If not provided, the default parameter set will be used.

  • inplace (bool, optional) – If True, replace the parameters values in place. Otherwise, return a new set of parameter values. Default is True.

  • options (dict-like, optional) – A dictionary of options to be passed to the model, see pybamm.BatteryModelOptions.

  • inputs (dict, optional) – A dictionary of input parameters to pass to the model when solving.

  • tol (float, optional) – The tolerance for the solver used to compute the initial stoichiometries. A lower value results in higher precision but may increase computation time. Default is 1e-6.