ControlVariableQ Struct Reference
Used to define a q control variable in a chemical equilibrium problem. More...
#include <EquilibriumSpecs.hpp>
Collaboration diagram for ControlVariableQ:
Public Types | |
using | ChemicalPotentialFn = Fn< real(ChemicalProps const &props, VectorXrConstRef const &p, VectorXrConstRef const &w)> |
The signature of functions that evaluate the prescribed chemical potential of a substance. More... | |
Public Attributes | |
String | name |
The unique name for this q control variable (required). | |
ChemicalFormula | substance |
The chemical formula of the substance associated to this q control variable (required). | |
String | id |
The unique identifier for the chemical potential constraint associated to this q control variable (required). | |
ChemicalPotentialFn | fn |
The chemical potential function associated to this q control variable (required). | |
Detailed Description
Used to define a q control variable in a chemical equilibrium problem.
The q control variables are used to specify the chemical potential of a species at chemical equilibrium. Its use implies that the system is open to a titrant with same chemical formula of the substance whose chemical potential needs to be constrained. A q control variable can also be used to specify the activity of a species and thus pH.
Member Typedef Documentation
◆ ChemicalPotentialFn
using ChemicalPotentialFn = Fn<real(ChemicalProps const& props, VectorXrConstRef const& p, VectorXrConstRef const& w)> |
The signature of functions that evaluate the prescribed chemical potential of a substance.
- Parameters
-
props The current chemical properties of the system in the equilibrium calculation. p The control variables p in the chemical equilibrium calculation. w The input variables w in the chemical equilibrium calculation.
The documentation for this struct was generated from the following file:
- Reaktoro/Equilibrium/EquilibriumSpecs.hpp