Previous topic

Particle

Next topic

Fickian Single Particle

This Page

Particle Base Model

class pybamm.particle.BaseParticle(param, domain)

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’

Extends: pybamm.BaseSubModel

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 a implemented in pybamm.BaseSubModel.

Parameters:variables (dict) – The variables in the whole model.