Single Particle Model (SPM)#

class pybamm.lithium_ion.SPM(options=None, name='Single Particle Model', build=True)[source]#

Single Particle Model (SPM) of a lithium-ion battery, from Marquis et al.[1]. See pybamm.lithium_ion.BaseModel for more details.

Examples

>>> model = pybamm.lithium_ion.SPM()
>>> model.name
'Single Particle Model'

Extends: pybamm.models.full_battery_models.lithium_ion.base_lithium_ion_model.BaseModel

View inheritance diagram for this model

Inheritance diagram of pybamm.models.full_battery_models.lithium_ion.spm.SPM

class pybamm.lithium_ion.BasicSPM(name='Single Particle Model')[source]#

Single Particle Model (SPM) model of a lithium-ion battery, from Marquis et al.[1].

This class differs from the pybamm.lithium_ion.SPM model class in that it shows the whole model in a single class. This comes at the cost of flexibility in combining different physical effects, and in general the main SPM class should be used instead.

Parameters:

name (str, optional) – The name of the model.

Extends: pybamm.models.full_battery_models.lithium_ion.base_lithium_ion_model.BaseModel

View inheritance diagram for this model

Inheritance diagram of pybamm.models.full_battery_models.lithium_ion.basic_spm.BasicSPM

class pybamm.lithium_ion.Basic3DThermalSPM(options=None, name='SPM with Separate Cell Domain')[source]#

Single Particle Model (SPM) model of a lithium-ion battery, from Marquis et al.[1].

This class differs from the pybamm.lithium_ion.SPM model class in that it shows the whole model in a single class. This comes at the cost of flexibility in combining different physical effects, and in general the main SPM class should be used instead.

The model is based on the SPM, but with a separate cell domain for the temperature variable. This allows for a more detailed treatment of the thermal effects in the cell, as the temperature can vary independently of the other variables in the model.

Parameters:

name (str, optional) – The name of the model.

Extends: pybamm.models.full_battery_models.lithium_ion.base_lithium_ion_model.BaseModel

View inheritance diagram for this model

Inheritance diagram of pybamm.models.full_battery_models.lithium_ion.basic_spm_with_3d_thermal.Basic3DThermalSPM

References