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 >

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.

Template Parameters

GV	the type of the grid view
T	the 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...

const GlobalPosition &	corner (unsigned int localIdx) const
	Returns a corner of the sub control volume 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

State the traits public and thus export all types.

Constructor & Destructor Documentation

◆ BoxDfmSubControlVolumeFace() [1/4]

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

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

default

The default constructor.

◆ 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

Constructor for inner scvfs.

◆ 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

Constructor for boundary scvfs.

◆ 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

Constructor for inner fracture scvfs.

Member Function Documentation

◆ area()

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

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

inline

The area of the sub control volume face.

◆ boundary()

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

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

inline

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

◆ boundaryFlag()

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

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

inline

Returns the boundary flag.

◆ center()

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

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

inline

The center of the sub control volume face.

◆ corner()

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

const GlobalPosition & Dumux::BoxDfmSubControlVolumeFace< GV, T >::corner ( unsigned int localIdx ) const

inline

Returns a corner of the sub control volume face.

◆ facetIndexInElement()

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

LocalIndexType Dumux::BoxDfmSubControlVolumeFace< GV, T >::facetIndexInElement ( ) const

inline

The element-local facet index for which a fracture scv was created.

◆ geometry()

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

Geometry Dumux::BoxDfmSubControlVolumeFace< GV, T >::geometry ( ) const

inline

The geometry of the sub control volume face.

◆ index()

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

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

inline

The global index of this sub control volume face.

◆ insideScvIdx()

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

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

inline

index of the inside sub control volume

◆ ipGlobal()

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

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

inline

The integration point for flux evaluations in global coordinates.

◆ isOnFracture()

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

bool Dumux::BoxDfmSubControlVolumeFace< GV, T >::isOnFracture ( ) const

inline

Return if this is a fracture scvf.

◆ numOutsideScvs()

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

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

inline

The number of scvs on the outside of this face.

◆ outsideScvIdx()

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

LocalIndexType Dumux::BoxDfmSubControlVolumeFace< 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 = BoxDfmDefaultScvfGeometryTraits<GV>>

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

inline

returns the unit normal vector pointing outwards

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

porousmediumflow/boxdfm/subcontrolvolumeface.hh

Description

Public Types

Public Member Functions

Member Typedef Documentation

◆ Traits

Constructor & Destructor Documentation

◆ BoxDfmSubControlVolumeFace() [1/4]

◆ BoxDfmSubControlVolumeFace() [2/4]

◆ BoxDfmSubControlVolumeFace() [3/4]

◆ BoxDfmSubControlVolumeFace() [4/4]

Member Function Documentation

◆ area()

◆ boundary()

◆ boundaryFlag()

◆ center()

◆ corner()

◆ facetIndexInElement()

◆ geometry()

◆ index()

◆ insideScvIdx()

◆ ipGlobal()

◆ isOnFracture()

◆ numOutsideScvs()

◆ outsideScvIdx()

◆ unitOuterNormal()