Base Lithium-ion Model#

class pybamm.lithium_ion.BaseModel(options=None, name='Unnamed lithium-ion model', build=False)#

Overwrites default parameters from Base Model with default parameters for lithium-ion 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

property calc_esoh#: Whether to include eSOH variables in the summary variables.

property default_parameter_values#: Returns the default parameter values for the model (an empty set of parameters by default).

property default_quick_plot_variables#: Returns the default variables for quick plotting (None by default).

insert_reference_electrode(position=None)#

Insert a reference electrode to measure the electrolyte potential at a given position in space. Adds model variables for the electrolyte potential at the reference electrode and for the potential difference between the electrode potentials measured at the electrode/current collector interface and the reference electrode. Only implemented for 1D models (i.e. where the ‘dimensionality’ option is 0).

Parameters:: position (pybamm.Symbol, optional) – The position in space at which to measure the electrolyte potential. If None, defaults to the mid-point of the separator.

set_default_summary_variables()#: Sets the default summary variables.

set_degradation_variables()#: Sets variables that quantify degradation (LAM, LLI, etc)