version 3.9-dev
Public Types | Public Member Functions | List of all members
Dumux::StaggeredSubControlVolumeFace< GV, T > Class Template Reference
Discretization schemes » Staggered FV scheme

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

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

Inheritance diagram for Dumux::StaggeredSubControlVolumeFace< GV, T >:

Public Types

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

Public Member Functions

 StaggeredSubControlVolumeFace ()=default
 
template<class Intersection , class GeometryHelper >
 StaggeredSubControlVolumeFace (const Intersection &is, const typename Intersection::Geometry &isGeometry, GridIndexType scvfIndex, const std::vector< GridIndexType > &scvIndices, const GeometryHelper &geometryHelper)
 Constructor with intersection. More...
 
const GlobalPosition & center () const
 The center of the sub control volume face. More...
 
const GlobalPosition & dofPosition () const
 The position of the dof living on the face. More...
 
const GlobalPosition & ipGlobal () const
 The integration point for flux evaluations in global coordinates. More...
 
Scalar area () const
 The area of the sub control volume face. More...
 
bool boundary () const
 Returns boolean if the sub control volume face is on the boundary. More...
 
const GlobalPosition & unitOuterNormal () const
 The unit outer normal vector. More...
 
GridIndexType insideScvIdx () const
 Index of the inside sub control volume. More...
 
GridIndexType outsideScvIdx () const
 Index of the outside sub control volume. More...
 
GridIndexType index () const
 The global index of this sub control volume face. More...
 
GridIndexType dofIndex () const
 The global index of the dof living on this face. More...
 
LocalIndexType localFaceIdx () const
 The local index of this sub control volume face. More...
 
GridIndexType outsideScvIdx (int i=0) const
 

Member Typedef Documentation

◆ GlobalPosition

template<class GV , class T = StaggeredDefaultScvfGeometryTraits<GV>>
using Dumux::StaggeredSubControlVolumeFace< GV, T >::GlobalPosition = typename T::GlobalPosition

◆ Traits

template<class GV , class T = StaggeredDefaultScvfGeometryTraits<GV>>
using Dumux::StaggeredSubControlVolumeFace< GV, T >::Traits = T

Constructor & Destructor Documentation

◆ StaggeredSubControlVolumeFace() [1/2]

template<class GV , class T = StaggeredDefaultScvfGeometryTraits<GV>>
Dumux::StaggeredSubControlVolumeFace< GV, T >::StaggeredSubControlVolumeFace ( )
default

◆ StaggeredSubControlVolumeFace() [2/2]

template<class GV , class T = StaggeredDefaultScvfGeometryTraits<GV>>
template<class Intersection , class GeometryHelper >
Dumux::StaggeredSubControlVolumeFace< GV, T >::StaggeredSubControlVolumeFace ( const Intersection &  is,
const typename Intersection::Geometry &  isGeometry,
GridIndexType  scvfIndex,
const std::vector< GridIndexType > &  scvIndices,
const GeometryHelper &  geometryHelper 
)
inline

Member Function Documentation

◆ area()

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

◆ boundary()

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

◆ center()

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

◆ dofIndex()

template<class GV , class T = StaggeredDefaultScvfGeometryTraits<GV>>
GridIndexType Dumux::StaggeredSubControlVolumeFace< GV, T >::dofIndex ( ) const
inline

◆ dofPosition()

template<class GV , class T = StaggeredDefaultScvfGeometryTraits<GV>>
const GlobalPosition & Dumux::StaggeredSubControlVolumeFace< GV, T >::dofPosition ( ) const
inline

◆ index()

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

◆ insideScvIdx()

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

◆ ipGlobal()

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

◆ localFaceIdx()

template<class GV , class T = StaggeredDefaultScvfGeometryTraits<GV>>
LocalIndexType Dumux::StaggeredSubControlVolumeFace< GV, T >::localFaceIdx ( ) const
inline

◆ outsideScvIdx() [1/2]

template<class GV , class T = StaggeredDefaultScvfGeometryTraits<GV>>
GridIndexType Dumux::StaggeredSubControlVolumeFace< GV, T >::outsideScvIdx ( ) const
inline

◆ outsideScvIdx() [2/2]

GridIndexType Dumux::SubControlVolumeFaceBase< StaggeredSubControlVolumeFace< GV, StaggeredDefaultScvfGeometryTraits< GV > > , StaggeredDefaultScvfGeometryTraits< GV > >::outsideScvIdx ( int  i = 0) const
inlineinherited

index of the outside sub control volume for spatial param evaluation This results in undefined behaviour if boundary is true In case of multiple outside scv indices (network grids) an index can be supplied

◆ unitOuterNormal()

template<class GV , class T = StaggeredDefaultScvfGeometryTraits<GV>>
const GlobalPosition & Dumux::StaggeredSubControlVolumeFace< GV, T >::unitOuterNormal ( ) const
inline
The documentation for this class was generated from the following file: