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 phaseIdx, unsigned compIdx, Scalar value)
void	set (unsigned phaseIdx, unsigned compIdx, Scalar value)
	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

template<class Scalar>

Opm::MMPCAuxConstraint< Scalar >::MMPCAuxConstraint ( )

inline

template<class Scalar>

Opm::MMPCAuxConstraint< Scalar >::MMPCAuxConstraint ( unsigned  phaseIdx, unsigned  compIdx, Scalar  value  )

inline

Member Function Documentation

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::MMPCAuxConstraint< Scalar >::set().

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::MMPCAuxConstraint< Scalar >::set().

template<class Scalar>

void Opm::MMPCAuxConstraint< Scalar >::set ( unsigned  phaseIdx, unsigned  compIdx, Scalar  value  )

inline

Specify the auxiliary constraint.

References Opm::MMPCAuxConstraint< Scalar >::compIdx(), Opm::MMPCAuxConstraint< Scalar >::phaseIdx(), and Opm::MMPCAuxConstraint< Scalar >::value().

template<class Scalar>

Scalar Opm::MMPCAuxConstraint< Scalar >::value ( ) const

inline

Returns value of the mole fraction of the auxiliary constraint.

Referenced by Opm::MMPCAuxConstraint< Scalar >::set().

---

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

• MiscibleMultiPhaseComposition.hpp