Opm::NcpExtensiveQuantities< TypeTag > Class Template Reference

This template class represents the extensive quantities of the compositional NCP model. More...

#include <ncpextensivequantities.hh>

Inheritance diagram for Opm::NcpExtensiveQuantities< TypeTag >:
Inheritance graph

Public Member Functions

void update (const ElementContext &elemCtx, unsigned scvfIdx, unsigned timeIdx)
 Update the extensive quantities for a given sub-control-volume-face. More...
 
template<class Context , class FluidState >
void updateBoundary (const Context &context, unsigned bfIdx, unsigned timeIdx, const FluidState &fluidState)
 Update the extensive quantities for a given boundary face. More...
 
short upstreamIndex (unsigned phaseIdx) const
 Return the local index of the upstream control volume for a given phase as a function of the normal flux. More...
 
short downstreamIndex (unsigned phaseIdx) const
 Return the local index of the downstream control volume for a given phase as a function of the normal flux. More...
 
Scalar upstreamWeight (unsigned) const
 Return the weight of the upstream control volume for a given phase as a function of the normal flux. More...
 
Scalar downstreamWeight (unsigned phaseIdx) const
 Return the weight of the downstream control volume for a given phase as a function of the normal flux. More...
 

Static Public Member Functions

static void registerParameters ()
 Register all run-time parameters for the extensive quantities. More...
 

Detailed Description

template<class TypeTag>
class Opm::NcpExtensiveQuantities< TypeTag >

This template class represents the extensive quantities of the compositional NCP model.

Member Function Documentation

◆ downstreamIndex()

template<class TypeTag >
short Opm::MultiPhaseBaseExtensiveQuantities< TypeTag >::downstreamIndex ( unsigned  phaseIdx) const
inlineinherited

Return the local index of the downstream control volume for a given phase as a function of the normal flux.

Parameters
phaseIdxThe index of the fluid phase for which the downstream direction is requested.

◆ downstreamWeight()

template<class TypeTag >
Scalar Opm::MultiPhaseBaseExtensiveQuantities< TypeTag >::downstreamWeight ( unsigned  phaseIdx) const
inlineinherited

Return the weight of the downstream control volume for a given phase as a function of the normal flux.

Parameters
phaseIdxThe index of the fluid phase

References Opm::MultiPhaseBaseExtensiveQuantities< TypeTag >::upstreamWeight().

◆ registerParameters()

template<class TypeTag >
static void Opm::MultiPhaseBaseExtensiveQuantities< TypeTag >::registerParameters ( )
inlinestaticinherited

Register all run-time parameters for the extensive quantities.

Referenced by Opm::ImmiscibleExtensiveQuantities< TypeTag >::registerParameters().

◆ update()

template<class TypeTag >
void Opm::NcpExtensiveQuantities< TypeTag >::update ( const ElementContext &  elemCtx,
unsigned  scvfIdx,
unsigned  timeIdx 
)
inline

Update the extensive quantities for a given sub-control-volume-face.

Parameters
elemCtxReference to the current element context.
scvfIdxThe local index of the sub-control-volume face for which the extensive quantities should be calculated.
timeIdxThe index used by the time discretization.

References Opm::MultiPhaseBaseExtensiveQuantities< TypeTag >::update().

◆ updateBoundary()

template<class TypeTag >
template<class Context , class FluidState >
void Opm::NcpExtensiveQuantities< TypeTag >::updateBoundary ( const Context &  context,
unsigned  bfIdx,
unsigned  timeIdx,
const FluidState &  fluidState 
)
inline

Update the extensive quantities for a given boundary face.

Parameters
contextReference to the current execution context.
bfIdxThe local index of the boundary face for which the extensive quantities should be calculated.
timeIdxThe index used by the time discretization.
fluidStateThe FluidState on the domain boundary.
paramCacheThe FluidSystem's parameter cache.

References Opm::MultiPhaseBaseExtensiveQuantities< TypeTag >::updateBoundary().

◆ upstreamIndex()

template<class TypeTag >
short Opm::MultiPhaseBaseExtensiveQuantities< TypeTag >::upstreamIndex ( unsigned  phaseIdx) const
inlineinherited

Return the local index of the upstream control volume for a given phase as a function of the normal flux.

Parameters
phaseIdxThe index of the fluid phase for which the upstream direction is requested.

◆ upstreamWeight()

template<class TypeTag >
Scalar Opm::MultiPhaseBaseExtensiveQuantities< TypeTag >::upstreamWeight ( unsigned  ) const
inlineinherited

Return the weight of the upstream control volume for a given phase as a function of the normal flux.

Parameters
phaseIdxThe index of the fluid phase

Referenced by Opm::MultiPhaseBaseExtensiveQuantities< TypeTag >::downstreamWeight().


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