version 3.8
Dumux::BoxDfmSubControlVolumeFace< GV, T > Class Template Reference

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

#include <dumux/porousmediumflow/boxdfm/subcontrolvolumeface.hh>

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

Description

template<class GV, class T = BoxDfmDefaultScvfGeometryTraits<GV>>
class Dumux::BoxDfmSubControlVolumeFace< GV, T >
Template Parameters
GVthe type of the grid view
Tthe scvf geometry traits

Public Types

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

Public Member Functions

 BoxDfmSubControlVolumeFace ()=default
 The default constructor. More...
 
template<class GeometryHelper , class Element >
 BoxDfmSubControlVolumeFace (const GeometryHelper &geometryHelper, const Element &element, const typename Element::Geometry &elemGeometry, GridIndexType scvfIndex, std::vector< LocalIndexType > &&scvIndices)
 Constructor for inner scvfs. More...
 
template<class GeometryHelper , class Intersection >
 BoxDfmSubControlVolumeFace (const GeometryHelper &geometryHelper, const Intersection &intersection, const typename Intersection::Geometry &isGeometry, LocalIndexType indexInIntersection, GridIndexType scvfIndex, std::vector< LocalIndexType > &&scvIndices)
 Constructor for boundary scvfs. More...
 
template<class GeometryHelper , class Intersection >
 BoxDfmSubControlVolumeFace (const GeometryHelper &geometryHelper, const Intersection &intersection, const typename Intersection::Geometry &isGeometry, LocalIndexType indexInIntersection, GridIndexType scvfIndex, std::vector< LocalIndexType > &&scvIndices, bool boundary)
 Constructor for inner fracture scvfs. More...
 
const GlobalPosition & center () const
 The center of the sub control volume 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 true if the sub control volume face is on the boundary More...
 
const GlobalPosition & unitOuterNormal () const
 returns the unit normal vector pointing outwards More...
 
GridIndexType index () const
 The global index of this sub control volume face. More...
 
bool isOnFracture () const
 Return if this is a fracture scvf. More...
 
LocalIndexType facetIndexInElement () const
 The element-local facet index for which a fracture scv was created. More...
 
BoundaryFlag::value_type boundaryFlag () const
 Returns the boundary flag. More...
 
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...
 
Geometry geometry () const
 The geometry of the sub control volume face. More...
 

Member Typedef Documentation

◆ Traits

template<class GV , class T = BoxDfmDefaultScvfGeometryTraits<GV>>
using Dumux::BoxDfmSubControlVolumeFace< GV, T >::Traits = T

Constructor & Destructor Documentation

◆ BoxDfmSubControlVolumeFace() [1/4]

template<class GV , class T = BoxDfmDefaultScvfGeometryTraits<GV>>
Dumux::BoxDfmSubControlVolumeFace< GV, T >::BoxDfmSubControlVolumeFace ( )
default

◆ BoxDfmSubControlVolumeFace() [2/4]

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

◆ BoxDfmSubControlVolumeFace() [3/4]

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

◆ BoxDfmSubControlVolumeFace() [4/4]

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

Member Function Documentation

◆ area()

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

◆ boundary()

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

◆ boundaryFlag()

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

◆ center()

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

◆ facetIndexInElement()

template<class GV , class T = BoxDfmDefaultScvfGeometryTraits<GV>>
LocalIndexType Dumux::BoxDfmSubControlVolumeFace< GV, T >::facetIndexInElement ( ) const
inline

◆ geometry()

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

◆ index()

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

◆ insideScvIdx()

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

◆ ipGlobal()

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

◆ isOnFracture()

template<class GV , class T = BoxDfmDefaultScvfGeometryTraits<GV>>
bool Dumux::BoxDfmSubControlVolumeFace< GV, T >::isOnFracture ( ) const
inline

◆ numOutsideScvs()

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

◆ outsideScvIdx()

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

◆ unitOuterNormal()

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

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