Voltage Model#

class pybamm.equivalent_circuit_elements.VoltageModel(param, options=None)#

Voltage model for use with equivalent circuits. This model is used to calculate the voltage and total overpotentials from the other elements in the circuit.

Parameters:

param (parameter class) – The parameters to use for this submodel
options (dict, optional) – A dictionary of options to be passed to the model.

Extends: pybamm.models.submodels.base_submodel.BaseSubModel

get_coupled_variables(variables)#

A public method that creates and returns the variables in a submodel which require variables in other submodels to be set first. For example, the exchange current density requires the concentration in the electrolyte to be created before it can be created. If a variable can be created independent of other submodels then it should be created in ‘get_fundamental_variables’ instead of this method.

Parameters:: variables (dict) – The variables in the whole model.
Returns:: The variables created in this submodel which depend on variables in other submodels.
Return type:: dict

set_events(variables)#

A method to set events related to the state of submodel variable. Note: this method modifies the state of self.events. Unless overwritten by a submodel, the default behaviour of ‘pass’ is used as implemented in pybamm.BaseSubModel.

Parameters:: variables (dict) – The variables in the whole model.