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 >

Template Parameters

GV	the type of the grid view
T	the 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 Corners , class Element >
	BoxSubControlVolumeFace (const Corners &corners, const GlobalPosition &normal, const Element &element, const typename Element::Geometry &elemGeometry, GridIndexType scvfIndex, std::vector< LocalIndexType > &&scvIndices, bool boundary=false)
	Constructor for inner scvfs. More...
template<class Corners , class Intersection >
	BoxSubControlVolumeFace (const Corners &corners, const GlobalPosition &normal, 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 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
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...
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

Traits

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>

using Dumux::BoxSubControlVolumeFace< GV, T >::Traits = T

Constructor & Destructor Documentation

BoxSubControlVolumeFace() [1/3]

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>

Dumux::BoxSubControlVolumeFace< GV, T >::BoxSubControlVolumeFace ( )

default

BoxSubControlVolumeFace() [2/3]

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>

template<class Corners , class Element >

Dumux::BoxSubControlVolumeFace< GV, T >::BoxSubControlVolumeFace ( const Corners &  corners, const GlobalPosition &  normal, const Element &  element, const typename Element::Geometry &  elemGeometry, GridIndexType  scvfIndex, std::vector< LocalIndexType > &&  scvIndices, bool  boundary = false  )

inline

BoxSubControlVolumeFace() [3/3]

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>

template<class Corners , class Intersection >

Dumux::BoxSubControlVolumeFace< GV, T >::BoxSubControlVolumeFace ( const Corners &  corners, const GlobalPosition &  normal, const Intersection &  intersection, const typename Intersection::Geometry &  isGeometry, LocalIndexType  indexInIntersection, GridIndexType  scvfIndex, std::vector< LocalIndexType > &&  scvIndices, bool  boundary = false  )

inline

Member Function Documentation

area()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>

Scalar Dumux::BoxSubControlVolumeFace< GV, T >::area ( ) const

inline

boundary()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>

bool Dumux::BoxSubControlVolumeFace< GV, T >::boundary ( ) const

inline

boundaryFlag()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>

BoundaryFlag::value_type Dumux::BoxSubControlVolumeFace< GV, T >::boundaryFlag ( ) const

inline

center()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>

const GlobalPosition & Dumux::BoxSubControlVolumeFace< GV, T >::center ( ) const

inline

index()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>

GridIndexType Dumux::BoxSubControlVolumeFace< GV, T >::index ( ) const

inline

insideScvIdx()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>

LocalIndexType Dumux::BoxSubControlVolumeFace< GV, T >::insideScvIdx ( ) const

inline

ipGlobal()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>

const GlobalPosition & Dumux::BoxSubControlVolumeFace< GV, T >::ipGlobal ( ) const

inline

numOutsideScvs()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>

std::size_t Dumux::BoxSubControlVolumeFace< GV, T >::numOutsideScvs ( ) const

inline

outsideScvIdx()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>

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

inline

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:

• discretization/box/subcontrolvolumeface.hh