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

#include <dumux/discretization/cellcentered/mpfa/subcontrolvolumeface.hh>

Description

template<class GV, class T = CCMpfaDefaultScvfGeometryTraits<GV>>
class Dumux::CCMpfaSubControlVolumeFace< GV, T >

Template Parameters

GV	the type of the grid view
T	the scvf geometry traits

Classes
struct	FacetInfo

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
template<class MpfaHelper , class Intersection >
	CCMpfaSubControlVolumeFace (const MpfaHelper &helper, CornerStorage &&corners, const Intersection &intersection, FacetInfo facetInfo, GridIndexType vIdxGlobal, unsigned int vIdxLocal, GridIndexType scvfIndex, GridIndexType insideScvIdx, const OutsideGridIndexStorage &outsideScvIndices, Scalar q, bool boundary)
	Constructor. 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 domain boundary More...

GridIndexType	index () const
	The global index of this sub control volume face. More...

GridIndexType	vertexIndex () const
	Returns the index of the vertex the scvf is connected to. More...

unsigned int	vertexIndexInElement () const
	Returns the element-local vertex index the scvf is connected to. More...

GridIndexType	insideScvIdx () const
	index of the inside sub control volume More...

std::size_t	numOutsideScvs () const
	The number of scvs on the outside of this scv face. More...

GridIndexType	outsideScvIdx (int i=0) const
	Index of the i-th outside sub control volume or boundary scv index. More...

const OutsideGridIndexStorage &	outsideScvIndices () const
	returns the outside scv indices (can be more than one index for dim < dimWorld) 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...

const GlobalPosition &	unitOuterNormal () const
	returns the unit outer normal vector (assumes non-curved geometries) More...

BoundaryFlag::value_type	boundaryFlag () const
	Return the boundary flag. More...

const FacetInfo &	facetInfo () const
	Return information on the facet from which this scvf was constructed. More...

Member Typedef Documentation

◆ GlobalPosition

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

using Dumux::CCMpfaSubControlVolumeFace< GV, T >::GlobalPosition = typename T::GlobalPosition

◆ Traits

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

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

Constructor & Destructor Documentation

◆ CCMpfaSubControlVolumeFace()

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

template<class MpfaHelper , class Intersection >

Dumux::CCMpfaSubControlVolumeFace< GV, T >::CCMpfaSubControlVolumeFace	(	const MpfaHelper &	helper,
		CornerStorage &&	corners,
		const Intersection &	intersection,
		FacetInfo	facetInfo,
		GridIndexType	vIdxGlobal,
		unsigned int	vIdxLocal,
		GridIndexType	scvfIndex,
		GridIndexType	insideScvIdx,
		const OutsideGridIndexStorage &	outsideScvIndices,
		Scalar	q,
		bool	boundary
	)

inline

Parameters

helper	The helper class for mpfa schemes
corners	The corners of the scv face
intersection	The intersection
facetInfo	Information on the facet from which this scvf is constructed
vIdxGlobal	The global vertex index the scvf is connected to
vIdxLocal	The element-local vertex index the scvf is connected to
scvfIndex	The global index of this scv face
insideScvIdx	The inside scv index connected to this face
outsideScvIndices	The outside scv indices connected to this face
q	The parameterization of the quadrature point on the scvf for flux calculation
boundary	Boolean to specify whether or not the scvf is on a boundary Construction with given intersection

Member Function Documentation

◆ area()

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

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

inline

◆ boundary()

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

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

inline

◆ boundaryFlag()

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

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

inline

◆ center()

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

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

inline

◆ facetInfo()

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

const FacetInfo & Dumux::CCMpfaSubControlVolumeFace< GV, T >::facetInfo ( ) const

inline

◆ index()

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

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

inline

◆ insideScvIdx()

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

GridIndexType Dumux::CCMpfaSubControlVolumeFace< GV, T >::insideScvIdx ( ) const

inline

◆ ipGlobal()

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

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

inline

◆ numOutsideScvs()

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

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

inline

◆ outsideScvIdx()

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

GridIndexType Dumux::CCMpfaSubControlVolumeFace< GV, T >::outsideScvIdx ( int i = 0 ) const

inline

◆ outsideScvIndices()

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

const OutsideGridIndexStorage & Dumux::CCMpfaSubControlVolumeFace< GV, T >::outsideScvIndices ( ) const

inline

◆ unitOuterNormal()

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

const GlobalPosition & Dumux::CCMpfaSubControlVolumeFace< GV, T >::unitOuterNormal ( ) const

inline

◆ vertexIndex()

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

GridIndexType Dumux::CCMpfaSubControlVolumeFace< GV, T >::vertexIndex ( ) const

inline

◆ vertexIndexInElement()

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

unsigned int Dumux::CCMpfaSubControlVolumeFace< GV, T >::vertexIndexInElement ( ) const

inline

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

discretization/cellcentered/mpfa/subcontrolvolumeface.hh

Description

Classes

Public Types

Public Member Functions

Member Typedef Documentation

◆ GlobalPosition

◆ Traits

Constructor & Destructor Documentation

◆ CCMpfaSubControlVolumeFace()

Member Function Documentation

◆ area()

◆ boundary()

◆ boundaryFlag()

◆ center()

◆ facetInfo()

◆ index()

◆ insideScvIdx()

◆ ipGlobal()

◆ numOutsideScvs()

◆ outsideScvIdx()

◆ outsideScvIndices()

◆ unitOuterNormal()

◆ vertexIndex()

◆ vertexIndexInElement()