Ewoms::StokesExtensiveQuantities< TypeTag > Class Template Reference

Contains the data which is required to calculate the mass and momentum fluxes over the face of a sub-control-volume for the Stokes model. More...

#include <stokesextensivequantities.hh>

Inheritance diagram for Ewoms::StokesExtensiveQuantities< TypeTag >:
Inheritance graph

Public Member Functions

void update (const ElementContext &elemCtx, int scvfIdx, int timeIdx, bool isBoundaryFace=false)
 Update all quantities which are required on an intersection between two finite volumes. More...
 
template<class Context , class FluidState >
void updateBoundary (const Context &context, int bfIdx, int timeIdx, const FluidState &fluidState, typename FluidSystem::ParameterCache &paramCache)
 Update the extensive quantities for a given boundary face. More...
 
Scalar pressure () const
 Return the pressure $\mathrm{[Pa]}$ at the integration point. More...
 
Scalar density () const
 Return the mass density $ \mathrm{[kg/m^3]} $ at the integration point. More...
 
Scalar molarDensity () const
 Return the molar density $ \mathrm{[mol/m^3]} $ at the integration point. More...
 
Scalar viscosity () const
 Return the viscosity $ \mathrm{[m^2/s]} $ at the integration point. More...
 
const DimVector & pressureGrad () const
 Return the pressure gradient at the integration point. More...
 
const DimVector & velocity () const
 Return the velocity vector at the integration point. More...
 
const DimVector & velocityGrad (int axisIdx) const
 Return the velocity gradient at the integration point of a face. More...
 
Scalar eddyViscosity () const
 Return the eddy viscosity (if implemented). More...
 
Scalar eddyDiffusivity () const
 Return the eddy diffusivity (if implemented). More...
 
Scalar volumeFlux (int phaseIdx) const
 Return the volume flux of mass. More...
 
Scalar upstreamWeight (int phaseIdx) const
 Return the weight of the upstream index. More...
 
Scalar downstreamWeight (int phaseIdx) const
 Return the weight of the downstream index. More...
 
int upstreamIndex (int phaseIdx) const
 Return the local index of the upstream sub-control volume. More...
 
int downstreamIndex (int phaseIdx) const
 Return the local index of the downstream sub-control volume. More...
 
int interiorIndex () const
 Return the local index of the sub-control volume which is located in negative normal direction. More...
 
int exteriorIndex () const
 Return the local index of the sub-control volume which is located in negative normal direction. More...
 
bool onBoundary () const
 Indicates if a face is on a boundary. Used for in the face() method (e.g. for outflow boundary conditions). More...
 
Scalar extrusionFactor () const
 Returns the extrusionFactor of the face. More...
 
const DimVector & normal () const
 Returns normal vector of the face of the extensive quantities. More...
 

Static Public Member Functions

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

Detailed Description

template<class TypeTag>
class Ewoms::StokesExtensiveQuantities< TypeTag >

Contains the data which is required to calculate the mass and momentum fluxes over the face of a sub-control-volume for the Stokes model.

This means pressure gradients, phase densities, viscosities, etc. at the integration point of the sub-control-volume face

Member Function Documentation

template<class TypeTag >
Scalar Ewoms::StokesExtensiveQuantities< TypeTag >::density ( ) const
inline

Return the mass density $ \mathrm{[kg/m^3]} $ at the integration point.

template<class TypeTag >
int Ewoms::StokesExtensiveQuantities< TypeTag >::downstreamIndex ( int  phaseIdx) const
inline

Return the local index of the downstream sub-control volume.

template<class TypeTag >
Scalar Ewoms::StokesExtensiveQuantities< TypeTag >::downstreamWeight ( int  phaseIdx) const
inline

Return the weight of the downstream index.

template<class TypeTag >
Scalar Ewoms::StokesExtensiveQuantities< TypeTag >::eddyDiffusivity ( ) const
inline

Return the eddy diffusivity (if implemented).

template<class TypeTag >
Scalar Ewoms::StokesExtensiveQuantities< TypeTag >::eddyViscosity ( ) const
inline

Return the eddy viscosity (if implemented).

template<class TypeTag >
int Ewoms::StokesExtensiveQuantities< TypeTag >::exteriorIndex ( ) const
inline

Return the local index of the sub-control volume which is located in negative normal direction.

template<class TypeTag >
Scalar Ewoms::StokesExtensiveQuantities< TypeTag >::extrusionFactor ( ) const
inline

Returns the extrusionFactor of the face.

template<class TypeTag >
int Ewoms::StokesExtensiveQuantities< TypeTag >::interiorIndex ( ) const
inline

Return the local index of the sub-control volume which is located in negative normal direction.

template<class TypeTag >
Scalar Ewoms::StokesExtensiveQuantities< TypeTag >::molarDensity ( ) const
inline

Return the molar density $ \mathrm{[mol/m^3]} $ at the integration point.

template<class TypeTag >
const DimVector& Ewoms::StokesExtensiveQuantities< TypeTag >::normal ( ) const
inline

Returns normal vector of the face of the extensive quantities.

template<class TypeTag >
bool Ewoms::StokesExtensiveQuantities< TypeTag >::onBoundary ( ) const
inline

Indicates if a face is on a boundary. Used for in the face() method (e.g. for outflow boundary conditions).

template<class TypeTag >
Scalar Ewoms::StokesExtensiveQuantities< TypeTag >::pressure ( ) const
inline

Return the pressure $\mathrm{[Pa]}$ at the integration point.

template<class TypeTag >
const DimVector& Ewoms::StokesExtensiveQuantities< TypeTag >::pressureGrad ( ) const
inline

Return the pressure gradient at the integration point.

template<class TypeTag >
static void Ewoms::StokesExtensiveQuantities< TypeTag >::registerParameters ( )
inlinestatic

Register all run-time parameters for the extensive quantities.

template<class TypeTag >
void Ewoms::StokesExtensiveQuantities< TypeTag >::update ( const ElementContext &  elemCtx,
int  scvfIdx,
int  timeIdx,
bool  isBoundaryFace = false 
)
inline

Update all quantities which are required on an intersection between two finite volumes.

Parameters
elemCtxThe current execution context.
scvfIdxThe local index of the sub-control volume face.
timeIdxThe index relevant for the time discretization.
isBoundaryFaceSpecifies whether the sub-control-volume face is on the domain boundary or not.

References Ewoms::VelocityComponentCallback< TypeTag >::setDimIndex().

Referenced by Ewoms::StokesExtensiveQuantities< TypeTag >::updateBoundary().

template<class TypeTag >
template<class Context , class FluidState >
void Ewoms::StokesExtensiveQuantities< TypeTag >::updateBoundary ( const Context &  context,
int  bfIdx,
int  timeIdx,
const FluidState &  fluidState,
typename FluidSystem::ParameterCache &  paramCache 
)
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 Ewoms::StokesExtensiveQuantities< TypeTag >::update().

template<class TypeTag >
int Ewoms::StokesExtensiveQuantities< TypeTag >::upstreamIndex ( int  phaseIdx) const
inline

Return the local index of the upstream sub-control volume.

template<class TypeTag >
Scalar Ewoms::StokesExtensiveQuantities< TypeTag >::upstreamWeight ( int  phaseIdx) const
inline

Return the weight of the upstream index.

template<class TypeTag >
const DimVector& Ewoms::StokesExtensiveQuantities< TypeTag >::velocity ( ) const
inline

Return the velocity vector at the integration point.

template<class TypeTag >
const DimVector& Ewoms::StokesExtensiveQuantities< TypeTag >::velocityGrad ( int  axisIdx) const
inline

Return the velocity gradient at the integration point of a face.

template<class TypeTag >
Scalar Ewoms::StokesExtensiveQuantities< TypeTag >::viscosity ( ) const
inline

Return the viscosity $ \mathrm{[m^2/s]} $ at the integration point.

template<class TypeTag >
Scalar Ewoms::StokesExtensiveQuantities< TypeTag >::volumeFlux ( int  phaseIdx) const
inline

Return the volume flux of mass.


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