Open circuit potential models

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

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”)

  • **Extends (** pybamm.BaseSubModel) –

class pybamm.open_circuit_potential.SingleOpenCircuitPotential(param, domain, reaction, options, phase='primary')
get_coupled_variables(variables)

A public method that creates and returns the variables in a submodel which require variables in other submodels to be set first. For example, the exchange current density requires the concentration in the electrolyte to be created before it can be created. If a variable can be created independent of other submodels then it should be created in ‘get_fundamental_variables’ instead of this method.

Parameters:

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

Returns:

The variables created in this submodel which depend on variables in other submodels.

Return type:

dict

class pybamm.open_circuit_potential.CurrentSigmoidOpenCircuitPotential(param, domain, reaction, options, phase='primary')
get_coupled_variables(variables)

A public method that creates and returns the variables in a submodel which require variables in other submodels to be set first. For example, the exchange current density requires the concentration in the electrolyte to be created before it can be created. If a variable can be created independent of other submodels then it should be created in ‘get_fundamental_variables’ instead of this method.

Parameters:

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

Returns:

The variables created in this submodel which depend on variables in other submodels.

Return type:

dict