Total Main Kinetics#

class pybamm.kinetics.TotalMainKinetics(param, domain, reaction, options)#

Class summing up contributions to the main (e.g. intercalation) reaction for cases with primary, secondary, … reactions e.g. silicon-graphite

Parameters:
  • param – model parameters

  • 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

Extends: pybamm.models.submodels.base_submodel.BaseSubModel

View inheritance diagram for this model

Inheritance diagram of pybamm.models.submodels.interface.kinetics.total_main_kinetics.TotalMainKinetics

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