Leading Order Model#

class pybamm.electrode.ohm.LeadingOrder(param, domain, options=None, set_positive_potential=True)#

An electrode submodel that employs Ohm’s law the leading-order approximation to governing equations.

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

  • domain (str) – Either ‘negative’ or ‘positive’

  • options (dict, optional) – A dictionary of options to be passed to the model.

  • set_positive_potential (bool, optional) – If True the battery model sets the positve potential based on the current. If False, the potential is specified by the user. Default is True.

Extends: pybamm.models.submodels.electrode.ohm.base_ohm.BaseModel

View inheritance diagram for this model

Inheritance diagram of pybamm.models.submodels.electrode.ohm.leading_ohm.LeadingOrder

get_coupled_variables(variables)#

Returns variables which are derived from the fundamental variables in the model.

set_boundary_conditions(variables)#

A method to set the boundary conditions for the submodel. Note: this method modifies the state of self.boundary_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.