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

Class for a sub control volume face in mpfa methods, i.e a part of the boundary of a control volume we compute fluxes on. More...

#include <dumux/discretization/cellcentered/mpfa/subcontrolvolumeface.hh>

Description

template<class GV, class T = CCMpfaDefaultScvfGeometryTraits<GV>>
class Dumux::CCMpfaSubControlVolumeFace< GV, T >

Class for a sub control volume face in mpfa methods, i.e a part of the boundary of a control volume we compute fluxes on.

Template Parameters
GVthe type of the grid view
Tthe scvf geometry traits

Public Types

using GlobalPosition = typename T::GlobalPosition
 export the type used for global coordinates More...
 
using Traits = T
 state the traits public and thus export all types More...
 

Public Member Functions

template<class MpfaHelper >
 CCMpfaSubControlVolumeFace (const MpfaHelper &helper, CornerStorage &&corners, GlobalPosition &&unitOuterNormal, GridIndexType vIdxGlobal, unsigned int vIdxLocal, GridIndexType scvfIndex, GridIndexType insideScvIdx, const OutsideGridIndexStorage &outsideScvIndices, Scalar q, bool boundary)
 Constructor. More...
 
template<class MpfaHelper , class Intersection >
 CCMpfaSubControlVolumeFace (const MpfaHelper &helper, CornerStorage &&corners, const Intersection &intersection, GridIndexType vIdxGlobal, unsigned int vIdxLocal, GridIndexType scvfIndex, GridIndexType insideScvIdx, const OutsideGridIndexStorage &outsideScvIndices, Scalar q, bool boundary)
 Construction with given intersection. More...
 
Scalar area () const
 The area of the sub control volume face. More...
 
bool boundary () const
 returns true if the sub control volume face is on the domain boundary More...
 
GridIndexType index () const
 The global index of this sub control volume face. More...
 
GridIndexType vertexIndex () const
 Returns the index of the vertex the scvf is connected to. More...
 
unsigned int vertexIndexInElement () const
 Returns the element-local vertex index the scvf is connected to. More...
 
GridIndexType insideScvIdx () const
 index of the inside sub control volume More...
 
std::size_t numOutsideScvs () const
 The number of scvs on the outside of this scv face. More...
 
GridIndexType outsideScvIdx (int i=0) const
 Index of the i-th outside sub control volume or boundary scv index. More...
 
const OutsideGridIndexStorage & outsideScvIndices () const
 returns the outside scv indices (can be more than one index for dim < dimWorld) More...
 
std::size_t corners () const
 Returns the number of corners. More...
 
const GlobalPositioncorner (unsigned int localIdx) const
 Returns the corner for a given local index. More...
 
const GlobalPositionvertexCorner () const
 Returns the global position of the vertex the scvf is connected to. More...
 
const GlobalPositionfacetCorner () const
 Returns the global position of the center of the element facet this scvf is embedded in. More...
 
const GlobalPositioncenter () const
 The center of the sub control volume face. More...
 
const GlobalPositionipGlobal () const
 The integration point for flux evaluations in global coordinates. More...
 
const GlobalPositionunitOuterNormal () const
 returns the unit outer normal vector (assumes non-curved geometries) More...
 
Geometry geometry () const
 The geometry of the sub control volume face. More...
 
BoundaryFlag::value_type boundaryFlag () const
 Return the boundary flag. More...
 

Member Typedef Documentation

◆ GlobalPosition

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
using Dumux::CCMpfaSubControlVolumeFace< GV, T >::GlobalPosition = typename T::GlobalPosition

export the type used for global coordinates

◆ Traits

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
using Dumux::CCMpfaSubControlVolumeFace< GV, T >::Traits = T

state the traits public and thus export all types

Constructor & Destructor Documentation

◆ CCMpfaSubControlVolumeFace() [1/2]

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
template<class MpfaHelper >
Dumux::CCMpfaSubControlVolumeFace< GV, T >::CCMpfaSubControlVolumeFace ( const MpfaHelper &  helper,
CornerStorage &&  corners,
GlobalPosition &&  unitOuterNormal,
GridIndexType  vIdxGlobal,
unsigned int  vIdxLocal,
GridIndexType  scvfIndex,
GridIndexType  insideScvIdx,
const OutsideGridIndexStorage &  outsideScvIndices,
Scalar  q,
bool  boundary 
)
inline

Constructor.

Parameters
helperThe helper class for mpfa schemes
cornersThe corners of the scv face
unitOuterNormalThe unit outer normal vector of the scvf
vIdxGlobalThe global vertex index the scvf is connected to
vIdxLocalThe element-local vertex index the scvf is connected to
scvfIndexThe global index of this scv face
insideScvIdxThe inside scv index connected to this face
outsideScvIndicesThe outside scv indices connected to this face
qThe parameterization of the quadrature point on the scvf for flux calculation
boundaryBoolean to specify whether or not the scvf is on a boundary

◆ CCMpfaSubControlVolumeFace() [2/2]

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
template<class MpfaHelper , class Intersection >
Dumux::CCMpfaSubControlVolumeFace< GV, T >::CCMpfaSubControlVolumeFace ( const MpfaHelper &  helper,
CornerStorage &&  corners,
const Intersection &  intersection,
GridIndexType  vIdxGlobal,
unsigned int  vIdxLocal,
GridIndexType  scvfIndex,
GridIndexType  insideScvIdx,
const OutsideGridIndexStorage &  outsideScvIndices,
Scalar  q,
bool  boundary 
)
inline

Construction with given intersection.

Member Function Documentation

◆ area()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
Scalar Dumux::CCMpfaSubControlVolumeFace< GV, T >::area ( ) const
inline

The area of the sub control volume face.

◆ boundary()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
bool Dumux::CCMpfaSubControlVolumeFace< GV, T >::boundary ( ) const
inline

returns true if the sub control volume face is on the domain boundary

◆ boundaryFlag()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
BoundaryFlag::value_type Dumux::CCMpfaSubControlVolumeFace< GV, T >::boundaryFlag ( ) const
inline

Return the boundary flag.

◆ center()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
const GlobalPosition & Dumux::CCMpfaSubControlVolumeFace< GV, T >::center ( ) const
inline

The center of the sub control volume face.

◆ corner()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
const GlobalPosition & Dumux::CCMpfaSubControlVolumeFace< GV, T >::corner ( unsigned int  localIdx) const
inline

Returns the corner for a given local index.

◆ corners()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
std::size_t Dumux::CCMpfaSubControlVolumeFace< GV, T >::corners ( ) const
inline

Returns the number of corners.

◆ facetCorner()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
const GlobalPosition & Dumux::CCMpfaSubControlVolumeFace< GV, T >::facetCorner ( ) const
inline

Returns the global position of the center of the element facet this scvf is embedded in.

◆ geometry()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
Geometry Dumux::CCMpfaSubControlVolumeFace< GV, T >::geometry ( ) const
inline

The geometry of the sub control volume face.

◆ index()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
GridIndexType Dumux::CCMpfaSubControlVolumeFace< GV, T >::index ( ) const
inline

The global index of this sub control volume face.

◆ insideScvIdx()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
GridIndexType Dumux::CCMpfaSubControlVolumeFace< GV, T >::insideScvIdx ( ) const
inline

index of the inside sub control volume

◆ ipGlobal()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
const GlobalPosition & Dumux::CCMpfaSubControlVolumeFace< GV, T >::ipGlobal ( ) const
inline

The integration point for flux evaluations in global coordinates.

◆ numOutsideScvs()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
std::size_t Dumux::CCMpfaSubControlVolumeFace< GV, T >::numOutsideScvs ( ) const
inline

The number of scvs on the outside of this scv face.

◆ outsideScvIdx()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
GridIndexType Dumux::CCMpfaSubControlVolumeFace< GV, T >::outsideScvIdx ( int  i = 0) const
inline

Index of the i-th outside sub control volume or boundary scv index.

◆ outsideScvIndices()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
const OutsideGridIndexStorage & Dumux::CCMpfaSubControlVolumeFace< GV, T >::outsideScvIndices ( ) const
inline

returns the outside scv indices (can be more than one index for dim < dimWorld)

◆ unitOuterNormal()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
const GlobalPosition & Dumux::CCMpfaSubControlVolumeFace< GV, T >::unitOuterNormal ( ) const
inline

returns the unit outer normal vector (assumes non-curved geometries)

◆ vertexCorner()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
const GlobalPosition & Dumux::CCMpfaSubControlVolumeFace< GV, T >::vertexCorner ( ) const
inline

Returns the global position of the vertex the scvf is connected to.

◆ vertexIndex()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
GridIndexType Dumux::CCMpfaSubControlVolumeFace< GV, T >::vertexIndex ( ) const
inline

Returns the index of the vertex the scvf is connected to.

◆ vertexIndexInElement()

template<class GV , class T = CCMpfaDefaultScvfGeometryTraits<GV>>
unsigned int Dumux::CCMpfaSubControlVolumeFace< GV, T >::vertexIndexInElement ( ) const
inline

Returns the element-local vertex index the scvf is connected to.


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