pybop.models.lithium_ion.basic_SPM#

Classes#

BaseGroupedSPM

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

Module Contents#

class pybop.models.lithium_ion.basic_SPM.BaseGroupedSPM(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.

  • eis (bool, optional) – A flag to build the forward model for EIS predictions. Defaults to False.

  • **model_kwargs (optional) –

    Valid PyBaMM model option keys and their values, for example: parameter_set : pybamm.ParameterValues or dict, optional

    The parameters for the model. If None, default parameters provided by PyBaMM are used.

    geometrydict, optional

    The geometry definitions for the model. If None, default geometry from PyBaMM is used.

    submesh_typesdict, optional

    The types of submeshes to use. If None, default submesh types from PyBaMM are used.

    var_ptsdict, optional

    The discretization points for each variable in the model. If None, default points from PyBaMM are used.

    spatial_methodsdict, optional

    The spatial methods used for discretization. If None, default spatial methods from PyBaMM are used.

    solverpybamm.Solver, optional

    The solver to use for simulating the model. If None, the default solver from PyBaMM is used.

    buildbool, optional

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

    optionsdict, optional

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

U(sto, domain)[source]#

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

static apply_parameter_grouping(parameter_set) → dict[source]#

A function to create a grouped SPM 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

build_model()[source]#

Build model variables and equations Credit: PyBaMM

property default_geometry[source]#

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

property default_parameter_values[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.