CurrentDriven Utilisation

class pybamm.interface.interface_utilisation.CurrentDriven(param, domain, options, reaction_loc)

Current-driven ODE for interface utilisation

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.

• reaction_loc (str) – Where the reaction happens: “x-average” (SPM, SPMe, etc), “full electrode” (full DFN), or “interface” (half-cell model)

Extends: pybamm.models.submodels.interface.interface_utilisation.base_utilisation.BaseModel

View inheritance diagram for this model

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_events(variables)

A method to set events related to the state of submodel variable. Note: this method modifies the state of self.events. 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 as implemented in pybamm.BaseSubModel.

Parameters:

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

set_rhs(variables)

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