Previous topic

Higher-Order Models

Next topic

Submodels

This Page

Full Model

class pybamm.lead_acid.Full(options=None, name='Full model', build=True)

Porous electrode model for lead-acid, from [1], based on the Newman-Tiedemann model.

Parameters:
  • options (dict, optional) – A dictionary of options to be passed to the model.
  • name (str, optional) – The name of the model.
  • build (bool, optional) – Whether to build the model on instantiation. Default is True. Setting this option to False allows users to change any number of the submodels before building the complete model (submodels cannot be changed after the model is built).

References

[1]V Sulzer, SJ Chapman, CP Please, DA Howey, and CW Monroe. Faster lead-acid battery simulations from porous-electrode theory: Part II. Asymptotic analysis. Journal of The Electrochemical Society 166.12 (2019), A2372–A2382.

Extends: pybamm.lead_acid.BaseModel

class pybamm.lead_acid.BasicFull(name='Basic full model')

Porous electrode model for lead-acid, from [2].

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

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

References

[2]V Sulzer, SJ Chapman, CP Please, DA Howey, and CW Monroe. Faster lead-acid battery simulations from porous-electrode theory: Part II. Asymptotic analysis. Journal of The Electrochemical Society 166.12 (2019), A2372–A2382..

Extends: pybamm.lead_acid.BaseModel

new_empty_copy()

See pybamm.BaseModel.new_empty_copy()