Base Model#

class pybamm.lead_acid.BaseModel(options=None, name='Unnamed lead-acid model', build=False)#

Overwrites default parameters from Base Model with default parameters for lead-acid models

Parameters:
  • options (dict-like, optional) – A dictionary of options to be passed to the model. If this is a dict (and not a subtype of dict), it will be processed by pybamm.BatteryModelOptions to ensure that the options are valid. If this is a subtype of dict, it is assumed that the options have already been processed and are valid. This allows for the use of custom options classes. The default options are given by pybamm.BatteryModelOptions.

  • name (str, optional) – The name of the model. The default is “Unnamed battery 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).

Extends: pybamm.models.full_battery_models.base_battery_model.BaseBatteryModel

View inheritance diagram for this model

Inheritance diagram of pybamm.models.full_battery_models.lead_acid.base_lead_acid_model.BaseModel

set_soc_variables()#

Set variables relating to the state of charge.