X-averaged Polynomial Profile

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

Class for molar conservation in a single x-averaged particle employing Fick’s law, with an assumed polynomial concentration profile in r. Model equations from [1].

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”)

References

Extends: pybamm.particle.PolynomialProfile

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

A method to set the differential equations which do not contain a time derivative. Note: this method modifies the state of self.algebraic. 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)

For single or x-averaged particle models, initial conditions can’t depend on x or r so we take the r- and x-average of the initial conditions.

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.