Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T > Class Template Reference

Face centered staggered sub control volume face. More...

#include <dumux/discretization/facecentered/staggered/subcontrolvolumeface.hh>

Description

template<class GridView, class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>
class Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >

Face centered staggered sub control volume face.

Public Types
enum class	FaceType : SmallLocalIndexType { frontal , lateral }
enum class	BoundaryType : SmallLocalIndexType { interior , physicalBoundary , processorBoundary }
using	Traits = T
	state the traits public and thus export all types More...
using	GlobalPosition = typename T::GlobalPosition

Public Member Functions
	FaceCenteredStaggeredSubControlVolumeFace ()=default
	FaceCenteredStaggeredSubControlVolumeFace (const ElementGeometry &elementGeometry, const IntersectionGeometry &intersectionGeometry, const std::array< GridIndexType, 2 > globalScvIndices, const SmallLocalIndexType localScvfIdx, const GridIndexType globalScvfIdx, const GlobalPosition &unitOuterNormal, const FaceType faceType, const BoundaryType boundaryType)
	The constructor for frontal faces. More...
template<class LateralFacetGeometry >
	FaceCenteredStaggeredSubControlVolumeFace (const ElementGeometry &elementGeometry, const IntersectionGeometry &intersectionGeometry, const LateralFacetGeometry &lateralFacetGeometry, const std::array< GridIndexType, 2 > globalScvIndices, const SmallLocalIndexType localScvfIdx, const GridIndexType globalScvfIdx, const GlobalPosition &unitOuterNormal, const FaceType faceType, const BoundaryType boundaryType)
	The constructor for lateral faces. More...
const GlobalPosition &	center () const
	The center of the sub control volume face. More...
const GlobalPosition &	ipGlobal () const
	The integration point of the sub control volume face. More...
const GlobalPosition	unitOuterNormal () const
	The unit outer normal. More...
GridIndexType	insideScvIdx () const
	Index of the inside sub control volume for spatial param evaluation. More...
GridIndexType	outsideScvIdx () const
	index of the outside sub control volume for spatial param evaluation More...
GridIndexType	index () const
SmallLocalIndexType	localIndex () const
FaceType	faceType () const
bool	boundary () const
bool	processorBoundary () const
bool	isFrontal () const
bool	isLateral () const
Scalar	area () const
SmallLocalIndexType	normalAxis () const
std::int_least8_t	directionSign () const
const GlobalPosition &	corner (unsigned int localIdx) const
Geometry	geometry () const
	The geometry of the sub control volume face. More...

Member Typedef Documentation

GlobalPosition

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

using Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::GlobalPosition = typename T::GlobalPosition

Traits

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

using Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::Traits = T

state the traits public and thus export all types

Member Enumeration Documentation

BoundaryType

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

enum class Dumux::FaceCenteredStaggeredSubControlVolumeFace::BoundaryType : SmallLocalIndexType

strong

Enumerator
interior
physicalBoundary
processorBoundary

FaceType

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

enum class Dumux::FaceCenteredStaggeredSubControlVolumeFace::FaceType : SmallLocalIndexType

strong

Enumerator
frontal
lateral

Constructor & Destructor Documentation

FaceCenteredStaggeredSubControlVolumeFace() [1/3]

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::FaceCenteredStaggeredSubControlVolumeFace ( )

default

FaceCenteredStaggeredSubControlVolumeFace() [2/3]

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::FaceCenteredStaggeredSubControlVolumeFace ( const ElementGeometry &  elementGeometry, const IntersectionGeometry &  intersectionGeometry, const std::array< GridIndexType, 2 >  globalScvIndices, const SmallLocalIndexType  localScvfIdx, const GridIndexType  globalScvfIdx, const GlobalPosition &  unitOuterNormal, const FaceType  faceType, const BoundaryType  boundaryType  )

inline

The constructor for frontal faces.

FaceCenteredStaggeredSubControlVolumeFace() [3/3]

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

template<class LateralFacetGeometry >

Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::FaceCenteredStaggeredSubControlVolumeFace ( const ElementGeometry &  elementGeometry, const IntersectionGeometry &  intersectionGeometry, const LateralFacetGeometry &  lateralFacetGeometry, const std::array< GridIndexType, 2 >  globalScvIndices, const SmallLocalIndexType  localScvfIdx, const GridIndexType  globalScvfIdx, const GlobalPosition &  unitOuterNormal, const FaceType  faceType, const BoundaryType  boundaryType  )

inline

The constructor for lateral faces.

Member Function Documentation

area()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

Scalar Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::area ( ) const

inline

boundary()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

bool Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::boundary ( ) const

inline

center()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

const GlobalPosition & Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::center ( ) const

inline

The center of the sub control volume face.

corner()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

const GlobalPosition & Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::corner ( unsigned int  localIdx ) const

inline

directionSign()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

std::int_least8_t Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::directionSign ( ) const

inline

faceType()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

FaceType Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::faceType ( ) const

inline

geometry()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

Geometry Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::geometry ( ) const

inline

The geometry of the sub control volume face.

index()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

GridIndexType Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::index ( ) const

inline

insideScvIdx()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

GridIndexType Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::insideScvIdx ( ) const

inline

Index of the inside sub control volume for spatial param evaluation.

ipGlobal()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

const GlobalPosition & Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::ipGlobal ( ) const

inline

The integration point of the sub control volume face.

isFrontal()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

bool Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::isFrontal ( ) const

inline

isLateral()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

bool Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::isLateral ( ) const

inline

localIndex()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

SmallLocalIndexType Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::localIndex ( ) const

inline

normalAxis()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

SmallLocalIndexType Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::normalAxis ( ) const

inline

outsideScvIdx()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

GridIndexType Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::outsideScvIdx ( ) const

inline

index of the outside sub control volume for spatial param evaluation

processorBoundary()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

bool Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::processorBoundary ( ) const

inline

unitOuterNormal()

template<class GridView , class T = FaceCenteredDefaultScvfGeometryTraits<GridView>>

const GlobalPosition Dumux::FaceCenteredStaggeredSubControlVolumeFace< GridView, T >::unitOuterNormal ( ) const

inline

The unit outer normal.

---

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

• discretization/facecentered/staggered/subcontrolvolumeface.hh