Opm::DensityCallback< TypeTag > Class Template Reference

Callback class for the density of 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

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

Detailed Description

template<class TypeTag>
class Opm::DensityCallback< TypeTag >

Callback class for the density of a phase.

Member Typedef Documentation

◆ ResultType

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

◆ ResultValueType

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

Constructor & Destructor Documentation

◆ DensityCallback() [1/2]

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

◆ DensityCallback() [2/2]

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

Member Function Documentation

◆ operator()()

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

Return the density of a phase given the index of a degree of freedom within an element context.

◆ setPhaseIndex()

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

Set the index of the fluid phase for which the density should be returned.


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