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::FaceCenteredStaggeredSubControlVolume< GridView, T > Class Template Reference

Face centered staggered sub control volume. More...

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

Description

template<class GridView, class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
class Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >

Face centered staggered sub control volume.

Public Types

using Traits = T
 state the traits public and thus export all types More...
 

Public Member Functions

 FaceCenteredStaggeredSubControlVolume ()=default
 
 FaceCenteredStaggeredSubControlVolume (const ElementGeometry &elementGeometry, const IntersectionGeometry &intersectionGeometry, const GridIndexType globalIndex, const SmallLocalIndexType indexInElement, const GridIndexType dofIdx, const SmallLocalIndexType dofAxis, const GridIndexType eIdx, const bool boundary)
 
const GlobalPosition & center () const
 The center of the sub control volume. More...
 
const GlobalPosition & dofPosition () const
 The position of the degree of freedom. More...
 
Scalar volume () const
 
GridIndexType dofIndex () const
 
GridIndexType index () const
 
GridIndexType elementIndex () const
 
SmallLocalIndexType indexInElement () const
 
SmallLocalIndexType localDofIndex () const
 
SmallLocalIndexType dofAxis () const
 
std::int_least8_t directionSign () const
 
bool boundary () const
 
const GlobalPosition & corner (unsigned int localIdx) const
 
Geometry geometry () const
 The geometry of the sub control volume face. More...
 

Member Typedef Documentation

◆ Traits

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
using Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::Traits = T

state the traits public and thus export all types

Constructor & Destructor Documentation

◆ FaceCenteredStaggeredSubControlVolume() [1/2]

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::FaceCenteredStaggeredSubControlVolume ( )
default

◆ FaceCenteredStaggeredSubControlVolume() [2/2]

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::FaceCenteredStaggeredSubControlVolume ( const ElementGeometry &  elementGeometry,
const IntersectionGeometry &  intersectionGeometry,
const GridIndexType  globalIndex,
const SmallLocalIndexType  indexInElement,
const GridIndexType  dofIdx,
const SmallLocalIndexType  dofAxis,
const GridIndexType  eIdx,
const bool  boundary 
)
inline

Member Function Documentation

◆ boundary()

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
bool Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::boundary ( ) const
inline

◆ center()

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
const GlobalPosition & Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::center ( ) const
inline

The center of the sub control volume.

◆ corner()

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
const GlobalPosition & Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::corner ( unsigned int  localIdx) const
inline

◆ directionSign()

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
std::int_least8_t Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::directionSign ( ) const
inline

◆ dofAxis()

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
SmallLocalIndexType Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::dofAxis ( ) const
inline

◆ dofIndex()

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
GridIndexType Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::dofIndex ( ) const
inline

◆ dofPosition()

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
const GlobalPosition & Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::dofPosition ( ) const
inline

The position of the degree of freedom.

◆ elementIndex()

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
GridIndexType Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::elementIndex ( ) const
inline

◆ geometry()

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
Geometry Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::geometry ( ) const
inline

The geometry of the sub control volume face.

◆ index()

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
GridIndexType Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::index ( ) const
inline

◆ indexInElement()

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
SmallLocalIndexType Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::indexInElement ( ) const
inline

◆ localDofIndex()

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
SmallLocalIndexType Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::localDofIndex ( ) const
inline

◆ volume()

template<class GridView , class T = FaceCenteredDefaultScvGeometryTraits<GridView>>
Scalar Dumux::FaceCenteredStaggeredSubControlVolume< GridView, T >::volume ( ) const
inline

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