Explicit control external circuit#
Current is explicitly specified, either by a function or in terms of other variables.
- class pybamm.external_circuit.ExplicitCurrentControl(param, options)[source]#
External circuit with current control.
Extends:
pybamm.models.submodels.external_circuit.base_external_circuit.BaseModel- get_fundamental_variables()[source]#
A public method that creates and returns the variables in a submodel which can be created independent of other submodels. For example, the electrolyte concentration variables can be created independent of whether any other variables have been defined in the model. As a rule, if a variable can be created without variables from other submodels, then it should be placed in this method.
- Returns:
The variables created by the submodel which are independent of variables in other submodels.
- Return type:
- set_algebraic(variables)[source]#
A method to set the differential equations which do not contain a time derivative. Note: this method modifies the state of self.algebraic. 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.
- set_initial_conditions(variables)[source]#
A method to set the initial conditions for the submodel. Note: this method modifies the state of self.initial_conditions. 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.
- class pybamm.external_circuit.ExplicitPowerControl(param, options)[source]#
External circuit with current set explicitly to hit target power.
Extends:
pybamm.models.submodels.external_circuit.base_external_circuit.BaseModel- get_coupled_variables(variables)[source]#
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.
- class pybamm.external_circuit.ExplicitResistanceControl(param, options)[source]#
External circuit with current set explicitly to hit target resistance.
Extends:
pybamm.models.submodels.external_circuit.base_external_circuit.BaseModel- get_coupled_variables(variables)[source]#
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.