Potential Pair models

class pybamm.current_collector.BasePotentialPair(param)

A submodel for Ohm’s law plus conservation of current in the current collectors. For details on the potential pair formulation see [1] and [2].

Parameters:

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

References

Extends: pybamm.current_collector.BaseModel

get_fundamental_variables()

A public method that creates and returns the variables in a submodel which can be created independent of other submodels. For example, the electrolyte concentration variables can be created independent of whether any other variables have been defined in the model. As a rule, if a variable can be created without variables from other submodels, then it should be placed in this method.

Returns:

The variables created by the submodel which are independent of variables in other submodels.

Return type:

dict

set_algebraic(variables)

A method to set the differential equations which do not contain a time derivative. Note: this method modifies the state of self.algebraic. 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.

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 a implemented in pybamm.BaseSubModel.

Parameters:

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

class pybamm.current_collector.PotentialPair2plus1D(param)

Base class for a 2+1D potential pair 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 a implemented in pybamm.BaseSubModel.

Parameters:

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

class pybamm.current_collector.PotentialPair1plus1D(param)

Base class for a 1+1D potential pair 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 a implemented in pybamm.BaseSubModel.

Parameters:

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