Constant Concentration#

class pybamm.electrolyte_diffusion.ConstantConcentration(param, options=None)#

Class for constant concentration of electrolyte

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

  • options (dict, optional) – A dictionary of options to be passed to the model.

Extends: pybamm.models.submodels.electrolyte_diffusion.base_electrolyte_diffusion.BaseElectrolyteDiffusion

View inheritance diagram for this model

Inheritance diagram of pybamm.models.submodels.electrolyte_diffusion.constant_concentration.ConstantConcentration

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

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_boundary_conditions(variables)#

We provide boundary conditions even though the concentration is constant so that the gradient of the concentration has the correct shape after discretisation.

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.