Class for molar conservation in particles employing Fick’s law, assuming a polynomial concentration profile in r, and allowing variation in the electrode domain. Model equations from [1].
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.BaseParticle
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.
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.
The variables created by the submodel which are independent of variables in other submodels.
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
.
variables (dict) – The variables in the whole model.
A method to set the initial conditions for the submodel. Note: this method
modifies the state of self.initial_conditions. Unless overwritten by a
submodel, the default behaviour of ‘pass’ is used a implemented in
pybamm.BaseSubModel
.
variables (dict) – The variables in the whole model.
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
.
variables (dict) – The variables in the whole model.