Public Types | Public Member Functions | List of all members
Opm::MoleFractionCallback< TypeTag > Class Template Reference

Callback class for a mole fraction of a component in a phase. More...

#include <quantitycallbacks.hh>

Public Types

using ResultType = typename std::remove_const< typename std::remove_reference< ResultRawType >::type >::type
 
using ResultValueType = typename MathToolbox< ResultType >::ValueType
 

Public Member Functions

 MoleFractionCallback (const ElementContext &elemCtx)
 
 MoleFractionCallback (const ElementContext &elemCtx, unsigned phaseIdx, unsigned compIdx)
 
void setPhaseIndex (unsigned phaseIdx)
 Set the index of the fluid phase for which a mole fraction should be returned. More...
 
void setComponentIndex (unsigned compIdx)
 Set the index of the component for which the mole fraction should be returned. More...
 
ResultType operator() (unsigned dofIdx) const
 Return the mole fraction of a component in a phase given the index of a degree of freedom within an element context. More...
 

Detailed Description

template<class TypeTag>
class Opm::MoleFractionCallback< TypeTag >

Callback class for a mole fraction of a component in a phase.

Member Typedef Documentation

◆ ResultType

template<class TypeTag >
using Opm::MoleFractionCallback< TypeTag >::ResultType = typename std::remove_const<typename std::remove_reference<ResultRawType>::type>::type

◆ ResultValueType

template<class TypeTag >
using Opm::MoleFractionCallback< TypeTag >::ResultValueType = typename MathToolbox<ResultType>::ValueType

Constructor & Destructor Documentation

◆ MoleFractionCallback() [1/2]

template<class TypeTag >
Opm::MoleFractionCallback< TypeTag >::MoleFractionCallback ( const ElementContext &  elemCtx)
inline

◆ MoleFractionCallback() [2/2]

template<class TypeTag >
Opm::MoleFractionCallback< TypeTag >::MoleFractionCallback ( const ElementContext &  elemCtx,
unsigned  phaseIdx,
unsigned  compIdx 
)
inline

Member Function Documentation

◆ operator()()

template<class TypeTag >
ResultType Opm::MoleFractionCallback< TypeTag >::operator() ( unsigned  dofIdx) const
inline

Return the mole fraction of a component in a phase given the index of a degree of freedom within an element context.

◆ setComponentIndex()

template<class TypeTag >
void Opm::MoleFractionCallback< TypeTag >::setComponentIndex ( unsigned  compIdx)
inline

Set the index of the component for which the mole fraction should be returned.

Referenced by Opm::DiffusionExtensiveQuantities< TypeTag, true >::update_().

◆ setPhaseIndex()

template<class TypeTag >
void Opm::MoleFractionCallback< TypeTag >::setPhaseIndex ( unsigned  phaseIdx)
inline

Set the index of the fluid phase for which a mole fraction should be returned.

Referenced by Opm::DiffusionExtensiveQuantities< TypeTag, true >::update_().

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