First-order Kinetics

class pybamm.interface.FirstOrderKinetics(param, domain, leading_order_model)

First-order kinetics

Parameters

• param – model parameters

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

• leading_order_model (pybamm.interface.kinetics.BaseKinetics) – The leading-order model with respect to which this is first-order

• **Extends (** pybamm.interface.BaseInterface) –

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.interface.InverseFirstOrderKinetics(param, domain, leading_order_models)

Base inverse first-order kinetics. This class needs to consider all of the leading-order submodels simultaneously in order to find the first-order correction to the potentials

Parameters

• param – model parameters

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

• leading_order_models (pybamm.interface.kinetics.BaseKinetics) – The leading-order models with respect to which this is first-order

• **Extends (** pybamm.interface.BaseInterface) –

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