Particle Base Model#

class pybamm.particle.BaseParticle(param, domain, options, phase='primary')#

Base class for molar conservation in particles.

Parameters:

param (parameter class) – The parameters to use for this submodel
domain (str) – The domain of the model either ‘Negative’ or ‘Positive’
options (dict) – A dictionary of options to be passed to the model. See pybamm.BaseBatteryModel
phase (str, optional) – Phase of the particle (default is “primary”)

Extends: pybamm.models.submodels.base_submodel.BaseSubModel

class pybamm.particle.TotalConcentration(param, domain, options, phase='primary')#

Class to calculate total particle concentrations

Parameters:

param (parameter class) – The parameters to use for this submodel
domain (str) – The domain of the model either ‘Negative’ or ‘Positive’
options (dict) – A dictionary of options to be passed to the model. See pybamm.BaseBatteryModel
phase (str, optional) – Phase of the particle (default is “primary”)

Extends: pybamm.models.submodels.particle.base_particle.BaseParticle

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