Opm::VelocityComponentCallback< TypeTag > Class Template Reference

Callback class for the velocity of a phase at the center of a DOF. 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

 VelocityComponentCallback (const ElementContext &elemCtx)
 
 VelocityComponentCallback (const ElementContext &elemCtx, unsigned dimIdx)
 
void setDimIndex (unsigned dimIdx)
 Set the index of the component of the velocity which should be returned. More...
 
ResultType operator() (unsigned dofIdx) const
 Return the velocity of a phase given the index of a degree of freedom within an element context. More...
 

Detailed Description

template<class TypeTag>
class Opm::VelocityComponentCallback< TypeTag >

Callback class for the velocity of a phase at the center of a DOF.

Member Typedef Documentation

◆ ResultType

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

◆ ResultValueType

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

Constructor & Destructor Documentation

◆ VelocityComponentCallback() [1/2]

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

◆ VelocityComponentCallback() [2/2]

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

Member Function Documentation

◆ operator()()

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

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

◆ setDimIndex()

template<class TypeTag >
void Opm::VelocityComponentCallback< TypeTag >::setDimIndex ( unsigned  dimIdx)
inline

Set the index of the component of the velocity which should be returned.


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