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::BoxSubControlVolumeFace< GV, T > Class Template Reference

Class for a sub control volume face in the box method, i.e a part of the boundary of a sub control volume we compute fluxes on. We simply use the base class here. More...

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

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

Description

template<class GV, class T = BoxDefaultScvfGeometryTraits<GV>>
class Dumux::BoxSubControlVolumeFace< GV, T >

Class for a sub control volume face in the box method, i.e a part of the boundary of a sub control volume we compute fluxes on. We simply use the base class here.

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

 BoxSubControlVolumeFace ()=default
 The default constructor. More...
 
template<class GeometryHelper , class Element >
 BoxSubControlVolumeFace (const GeometryHelper &geometryHelper, const Element &element, const typename Element::Geometry &elemGeometry, GridIndexType scvfIndex, std::vector< LocalIndexType > &&scvIndices, bool boundary=false)
 Constructor for inner scvfs. More...
 
template<class GeometryHelper , class Intersection >
 BoxSubControlVolumeFace (const GeometryHelper &geometryHelper, const Intersection &intersection, const typename Intersection::Geometry &isGeometry, LocalIndexType indexInIntersection, GridIndexType scvfIndex, std::vector< LocalIndexType > &&scvIndices, bool boundary=false)
 Constructor for boundary scvfs. 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...
 
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 boundary More...
 
const GlobalPositionunitOuterNormal () const
 
LocalIndexType insideScvIdx () const
 index of the inside sub control volume More...
 
LocalIndexType outsideScvIdx (int i=0) const
 Index of the i-th outside sub control volume or boundary scv index. More...
 
std::size_t numOutsideScvs () const
 The number of scvs on the outside of this face. More...
 
GridIndexType index () const
 The local index of this sub control volume face. More...
 
const GlobalPositioncorner (unsigned int localIdx) const
 
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 = BoxDefaultScvfGeometryTraits<GV>>
using Dumux::BoxSubControlVolumeFace< GV, T >::GlobalPosition = typename T::GlobalPosition

export the type used for global coordinates

◆ Traits

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
using Dumux::BoxSubControlVolumeFace< GV, T >::Traits = T

state the traits public and thus export all types

Constructor & Destructor Documentation

◆ BoxSubControlVolumeFace() [1/3]

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
Dumux::BoxSubControlVolumeFace< GV, T >::BoxSubControlVolumeFace ( )
default

The default constructor.

◆ BoxSubControlVolumeFace() [2/3]

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
template<class GeometryHelper , class Element >
Dumux::BoxSubControlVolumeFace< GV, T >::BoxSubControlVolumeFace ( const GeometryHelper &  geometryHelper,
const Element &  element,
const typename Element::Geometry &  elemGeometry,
GridIndexType  scvfIndex,
std::vector< LocalIndexType > &&  scvIndices,
bool  boundary = false 
)
inline

Constructor for inner scvfs.

◆ BoxSubControlVolumeFace() [3/3]

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
template<class GeometryHelper , class Intersection >
Dumux::BoxSubControlVolumeFace< GV, T >::BoxSubControlVolumeFace ( const GeometryHelper &  geometryHelper,
const Intersection &  intersection,
const typename Intersection::Geometry &  isGeometry,
LocalIndexType  indexInIntersection,
GridIndexType  scvfIndex,
std::vector< LocalIndexType > &&  scvIndices,
bool  boundary = false 
)
inline

Constructor for boundary scvfs.

Member Function Documentation

◆ area()

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

The area of the sub control volume face.

◆ boundary()

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

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

◆ boundaryFlag()

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

Return the boundary flag.

◆ center()

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

The center of the sub control volume face.

◆ corner()

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

◆ geometry()

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

The geometry of the sub control volume face.

◆ index()

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

The local index of this sub control volume face.

◆ insideScvIdx()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
LocalIndexType Dumux::BoxSubControlVolumeFace< GV, T >::insideScvIdx ( ) const
inline

index of the inside sub control volume

◆ ipGlobal()

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

The integration point for flux evaluations in global coordinates.

◆ numOutsideScvs()

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

The number of scvs on the outside of this face.

◆ outsideScvIdx()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
LocalIndexType Dumux::BoxSubControlVolumeFace< GV, T >::outsideScvIdx ( int  i = 0) const
inline

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

◆ unitOuterNormal()

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

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