Public Member Functions | List of all members
Opm::MMPCAuxConstraint< Scalar > Class Template Reference

Specifies an auxiliary constraint for the MiscibleMultiPhaseComposition constraint solver. More...

#include <MiscibleMultiPhaseComposition.hpp>

Public Member Functions

 MMPCAuxConstraint ()
 
 MMPCAuxConstraint (unsigned phaseIndex, unsigned compIndex, Scalar val)
 
void set (unsigned phaseIndex, unsigned compIndex, Scalar val)
 Specify the auxiliary constraint. More...
 
unsigned phaseIdx () const
 Returns the index of the fluid phase for which the auxiliary constraint is specified. More...
 
unsigned compIdx () const
 Returns the index of the component for which the auxiliary constraint is specified. More...
 
Scalar value () const
 Returns value of the mole fraction of the auxiliary constraint. More...
 

Detailed Description

template<class Scalar>
class Opm::MMPCAuxConstraint< Scalar >

Specifies an auxiliary constraint for the MiscibleMultiPhaseComposition constraint solver.

For this constraint solver, an auxiliary constraint is defined as a fixed mole fraction of a component in a fluid phase.

Constructor & Destructor Documentation

◆ MMPCAuxConstraint() [1/2]

template<class Scalar >
Opm::MMPCAuxConstraint< Scalar >::MMPCAuxConstraint ( )
inline

◆ MMPCAuxConstraint() [2/2]

template<class Scalar >
Opm::MMPCAuxConstraint< Scalar >::MMPCAuxConstraint ( unsigned  phaseIndex,
unsigned  compIndex,
Scalar  val 
)
inline

Member Function Documentation

◆ compIdx()

template<class Scalar >
unsigned Opm::MMPCAuxConstraint< Scalar >::compIdx ( ) const
inline

Returns the index of the component for which the auxiliary constraint is specified.

Referenced by Opm::MiscibleMultiPhaseComposition< Scalar, FluidSystem, Evaluation >::solve().

◆ phaseIdx()

template<class Scalar >
unsigned Opm::MMPCAuxConstraint< Scalar >::phaseIdx ( ) const
inline

Returns the index of the fluid phase for which the auxiliary constraint is specified.

Referenced by Opm::MiscibleMultiPhaseComposition< Scalar, FluidSystem, Evaluation >::solve().

◆ set()

template<class Scalar >
void Opm::MMPCAuxConstraint< Scalar >::set ( unsigned  phaseIndex,
unsigned  compIndex,
Scalar  val 
)
inline

Specify the auxiliary constraint.

◆ value()

template<class Scalar >
Scalar Opm::MMPCAuxConstraint< Scalar >::value ( ) const
inline

Returns value of the mole fraction of the auxiliary constraint.

Referenced by Opm::MiscibleMultiPhaseComposition< Scalar, FluidSystem, Evaluation >::solve().

The documentation for this class was generated from the following file: