MSMR Open Circuit Potential

class pybamm.open_circuit_potential.MSMROpenCircuitPotential(param, domain, reaction, options, phase='primary')

Class for open-circuit potential within the Multi-Species Multi-Reaction framework Baker and Verbrugge[1]. The thermodynamic model is presented in Verbrugge et al.[2], along with parameter values for a number of substitutional materials.

Extends: pybamm.models.submodels.interface.open_circuit_potential.base_ocp.BaseOpenCircuitPotential

View inheritance diagram for this model

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

References

[1]

Daniel R Baker and Mark W Verbrugge. Multi-species, multi-reaction model for porous intercalation electrodes: part i. model formulation and a perturbation solution for low-scan-rate, linear-sweep voltammetry of a spinel lithium manganese oxide electrode. Journal of The Electrochemical Society, 165(16):A3952, 2018.

[2]

Mark Verbrugge, Daniel Baker, Brian Koch, Xingcheng Xiao, and Wentian Gu. Thermodynamic model for substitutional materials: application to lithiated graphite, spinel manganese oxide, iron phosphate, and layered nickel-manganese-cobalt oxide. Journal of The Electrochemical Society, 164(11):E3243, 2017.