Base Battery Model

class pybamm.BaseBatteryModel(options=None, name='Unnamed battery model')

Base model class with some default settings and required variables Extends: pybamm.BaseModel

new_empty_copy()

See pybamm.BaseModel.new_empty_copy()

process_parameters_and_discretise(symbol, parameter_values, disc)

Process parameters and discretise a symbol using supplied parameter values and discretisation. Note: care should be taken if using spatial operators on dimensional symbols. Operators in pybamm are written in non-dimensional form, so may need to be scaled by the appropriate length scale. It is recommended to use this method on non-dimensional symbols.

Parameters:

• symbol (pybamm.Symbol) – Symbol to be processed
• parameter_values (pybamm.ParameterValues) – The parameter values to use during processing
• disc (pybamm.Discretisation) – The discrisation to use

Returns:

Processed symbol

Return type:

pybamm.Symbol

set_external_circuit_submodel()

Define how the external circuit defines the boundary conditions for the model, e.g. (not necessarily constant-) current, voltage, etc

set_soc_variables()

Set variables relating to the state of charge. This function is overriden by the base battery models