3.5-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Member Functions | List of all members
Dumux::StaggeredFaceVariables< FacePrimaryVariables, dim, upwindSchemeOrder > Class Template Reference

The face variables class for free flow staggered grid models. Contains all relevant velocities for the assembly of the momentum balance. When the upwindSchemeOrder is set to 2, additional velocities located at Dofs further from the central stencil will be added and used when calculating the advective term. When the order remains at 1, these velocities will not be provided. More...

#include <dumux/discretization/staggered/freeflow/facevariables.hh>

Description

template<class FacePrimaryVariables, int dim, int upwindSchemeOrder>
class Dumux::StaggeredFaceVariables< FacePrimaryVariables, dim, upwindSchemeOrder >

The face variables class for free flow staggered grid models. Contains all relevant velocities for the assembly of the momentum balance. When the upwindSchemeOrder is set to 2, additional velocities located at Dofs further from the central stencil will be added and used when calculating the advective term. When the order remains at 1, these velocities will not be provided.

Public Member Functions

void updateOwnFaceOnly (const FacePrimaryVariables &priVars)
 Partial update of the face variables. Only the face itself is considered. More...
 
template<class FaceSolution , class Problem , class Element , class FVElementGeometry , class SubControlVolumeFace >
void update (const FaceSolution &faceSol, const Problem &problem, const Element &element, const FVElementGeometry &fvGeometry, const SubControlVolumeFace &scvf)
 Complete update of the face variables (i.e. velocities for free flow) for a given face. More...
 
Scalar velocitySelf () const
 Returns the velocity at the face itself. More...
 
Scalar velocityOpposite () const
 Returns the velocity at the opposing face. More...
 
template<bool enable = useHigherOrder, std::enable_if_t< enable, int > = 0>
Scalar velocityBackward (const int backwardIdx) const
 Returns the velocity at a backward face. More...
 
template<bool enable = useHigherOrder, std::enable_if_t< enable, int > = 0>
Scalar velocityForward (const int forwardIdx) const
 Returns the velocity at a forward face. More...
 
Scalar velocityParallel (const int localSubFaceIdx, const int parallelDegreeIdx=0) const
 Returns the velocity at a parallel face. More...
 
Scalar velocityLateralInside (const int localSubFaceIdx) const
 Returns the velocity at the inner normal face. More...
 
Scalar velocityLateralOutside (const int localSubFaceIdx) const
 Returns the velocity at the outer normal face. More...
 

Member Function Documentation

◆ update()

template<class FacePrimaryVariables , int dim, int upwindSchemeOrder>
template<class FaceSolution , class Problem , class Element , class FVElementGeometry , class SubControlVolumeFace >
void Dumux::StaggeredFaceVariables< FacePrimaryVariables, dim, upwindSchemeOrder >::update ( const FaceSolution &  faceSol,
const Problem &  problem,
const Element &  element,
const FVElementGeometry &  fvGeometry,
const SubControlVolumeFace &  scvf 
)
inline

Complete update of the face variables (i.e. velocities for free flow) for a given face.

Parameters
faceSolThe face-specific solution vector
problemThe problem
elementThe element
fvGeometryThe finite-volume geometry
scvfThe sub-control volume face of interest

◆ updateOwnFaceOnly()

template<class FacePrimaryVariables , int dim, int upwindSchemeOrder>
void Dumux::StaggeredFaceVariables< FacePrimaryVariables, dim, upwindSchemeOrder >::updateOwnFaceOnly ( const FacePrimaryVariables &  priVars)
inline

Partial update of the face variables. Only the face itself is considered.

Parameters
priVarsThe face-specific primary variales

◆ velocityBackward()

template<class FacePrimaryVariables , int dim, int upwindSchemeOrder>
template<bool enable = useHigherOrder, std::enable_if_t< enable, int > = 0>
Scalar Dumux::StaggeredFaceVariables< FacePrimaryVariables, dim, upwindSchemeOrder >::velocityBackward ( const int  backwardIdx) const
inline

Returns the velocity at a backward face.

Parameters
backwardIdxThe index describing how many faces backward this dof is from the opposite face

◆ velocityForward()

template<class FacePrimaryVariables , int dim, int upwindSchemeOrder>
template<bool enable = useHigherOrder, std::enable_if_t< enable, int > = 0>
Scalar Dumux::StaggeredFaceVariables< FacePrimaryVariables, dim, upwindSchemeOrder >::velocityForward ( const int  forwardIdx) const
inline

Returns the velocity at a forward face.

Parameters
forwardIdxThe index describing how many faces forward this dof is of the self face

◆ velocityLateralInside()

template<class FacePrimaryVariables , int dim, int upwindSchemeOrder>
Scalar Dumux::StaggeredFaceVariables< FacePrimaryVariables, dim, upwindSchemeOrder >::velocityLateralInside ( const int  localSubFaceIdx) const
inline

Returns the velocity at the inner normal face.

Parameters
localSubFaceIdxThe local index of the subface

◆ velocityLateralOutside()

template<class FacePrimaryVariables , int dim, int upwindSchemeOrder>
Scalar Dumux::StaggeredFaceVariables< FacePrimaryVariables, dim, upwindSchemeOrder >::velocityLateralOutside ( const int  localSubFaceIdx) const
inline

Returns the velocity at the outer normal face.

Parameters
localSubFaceIdxThe local index of the subface

◆ velocityOpposite()

template<class FacePrimaryVariables , int dim, int upwindSchemeOrder>
Scalar Dumux::StaggeredFaceVariables< FacePrimaryVariables, dim, upwindSchemeOrder >::velocityOpposite ( ) const
inline

Returns the velocity at the opposing face.

◆ velocityParallel()

template<class FacePrimaryVariables , int dim, int upwindSchemeOrder>
Scalar Dumux::StaggeredFaceVariables< FacePrimaryVariables, dim, upwindSchemeOrder >::velocityParallel ( const int  localSubFaceIdx,
const int  parallelDegreeIdx = 0 
) const
inline

Returns the velocity at a parallel face.

Parameters
localSubFaceIdxThe local index of the subface
parallelDegreeIdxThe index describing how many faces parallel this dof is of the parallel face

◆ velocitySelf()

template<class FacePrimaryVariables , int dim, int upwindSchemeOrder>
Scalar Dumux::StaggeredFaceVariables< FacePrimaryVariables, dim, upwindSchemeOrder >::velocitySelf ( ) const
inline

Returns the velocity at the face itself.


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