pybop.models.lithium_ion.weppner_huggins#

Classes#

BaseWeppnerHuggins

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

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

    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.

_built = True[source]#
_summary_variables = [][source]#
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.

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.