Hyperbola of Revolution Transport Efficiency Model#

class pybamm.transport_efficiency.HyperbolaOfRevolution(param, component, options=None)#

Submodel for Hyperbola of revolution transport_efficiency Petersen[1], Shen and Chen[2]

Parameters:

  • param (parameter class) – The parameters to use for this submodel

  • component (str) – The material for the model (‘electrolyte’ or ‘electrode’).

  • options (dict, optional) – A dictionary of options to be passed to the model.

Extends: pybamm.models.submodels.transport_efficiency.base_transport_efficiency.BaseModel

View inheritance diagram for this model

Inheritance diagram of pybamm.models.submodels.transport_efficiency.hyperbola_of_revolution.HyperbolaOfRevolution

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