Base Open Circuit Potential

class pybamm.open_circuit_potential.BaseOpenCircuitPotential(param, domain, reaction, options, phase='primary', x_average=False)

Base class for open-circuit potentials

Parameters:

• param (parameter class) – The parameters to use for this submodel

• domain (str) – The domain to implement the model, either: ‘Negative’ or ‘Positive’.

• reaction (str) – The name of the reaction being implemented

• options (dict) – A dictionary of options to be passed to the model. See pybamm.BaseBatteryModel

• phase (str, optional) – Phase of the particle (default is “primary”)

• x_average (bool) – Whether the particle concentration is averaged over the x-direction. Default is False.

Extends: pybamm.models.submodels.interface.base_interface.BaseInterface

View inheritance diagram for this model

class pybamm.open_circuit_potential.BaseHysteresisOpenCircuitPotential(param, domain, reaction, options, phase='primary', x_average=False)

Base class for open-circuit potentials with single-state hysteresis

Parameters:

• param (parameter class) – The parameters to use for this submodel

• domain (str) – The domain to implement the model, either: ‘Negative’ or ‘Positive’.

• reaction (str) – The name of the reaction being implemented

• options (dict) – A dictionary of options to be passed to the model. See pybamm.BaseBatteryModel

• phase (str, optional) – Phase of the particle (default is “primary”)

• x_average (bool) – Whether the particle concentration is averaged over the x-direction. Default is False.

Extends: pybamm.models.submodels.interface.open_circuit_potential.base_ocp.BaseOpenCircuitPotential

View inheritance diagram for this model

set_initial_conditions(variables)

A method to set the initial conditions for the submodel. Note: this method modifies the state of self.initial_conditions. Unless overwritten by a submodel, the default behaviour of ‘pass’ is used as implemented in pybamm.BaseSubModel.

Parameters:

variables (dict) – The variables in the whole model.