Composite Model

class pybamm.electrode.ohm.Composite(param, domain, options=None)

An explicit composite leading and first order solution to solid phase current conservation with ohm’s law. Note that the returned current density is only the leading order approximation.

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

  • domain (str) – Either ‘Negative electrode’ or ‘Positive electrode’

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

  • **Extends (** pybamm.BaseOhm) –

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_boundary_conditions(variables)

A method to set the boundary conditions for the submodel. Note: this method modifies the state of self.boundary_conditions. Unless overwritten by a submodel, the default behaviour of ‘pass’ is used a implemented in pybamm.BaseSubModel.

Parameters:

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