pybop.models.lithium_ion.weppner_huggins#
Classes#
WeppnerHuggins Model for GITT. Credit: pybamm-param team. |
Module Contents#
- class pybop.models.lithium_ion.weppner_huggins.BaseWeppnerHuggins(name='Weppner & Huggins model', **model_kwargs)[source]#
Bases:
pybamm.lithium_ion.BaseModelWeppnerHuggins Model for GITT. Credit: pybamm-param team.
This model can be used with PyBOP through the pybop.WeppnerHuggins class.
- Parameters:
name (str, optional) – The name of the model.
**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.
- optionsdict, optional
A dictionary of options to customise the behaviour of the PyBaMM model.
- static apply_parameter_grouping(parameter_set, electrode) dict[source]#
A function to create an electrode 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.
electrode (str) – Either “positive” or “negative” for the type of electrode.
- Returns:
A dictionary of the grouped parameters.
- Return type:
dict
- 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_solver[source]#
Returns the default solver for the model, based on whether it is an ODE/DAE or algebraic model.
- 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.