Dumux::Experimental::BoundaryFace< GV, T > Class Template Reference

Class for a boundary face related to primary grid elements (dune intersections) More...

#include <dumux/discretization/boundaryface.hh>

Description

template<class GV, class T = DefaultBoundaryFaceGeometryTraits<GV>>
class Dumux::Experimental::BoundaryFace< GV, T >

Template Parameters

GV	the type of the grid view
T	the face 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
	BoundaryFace ()=default
	The default constructor. More...
	BoundaryFace (const GlobalPosition &center, const Scalar area, const GlobalPosition &normal, const LocalIndexType localIdx, const LocalIndexType intersectionIdx, const BoundaryFlag &bFlag)
	Constructor for boundary faces. More...
const GlobalPosition &	center () const
	The center of the face. More...
Scalar	area () const
	The area of the face. More...
bool	boundary () const
const GlobalPosition	unitOuterNormal () const
	The unit outer normal. More...
LocalIndexType	index () const
	The local index of this face. More...
LocalIndexType	intersectionIndex () const
	The index of the intersection this face corresponds to (intersection.indexInInside()) More...
BoundaryFlag::value_type	boundaryFlag () const
	Return the boundary flag. More...

Member Typedef Documentation

GlobalPosition

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

using Dumux::Experimental::BoundaryFace< GV, T >::GlobalPosition = typename T::GlobalPosition

Traits

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

using Dumux::Experimental::BoundaryFace< GV, T >::Traits = T

Constructor & Destructor Documentation

BoundaryFace() [1/2]

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

Dumux::Experimental::BoundaryFace< GV, T >::BoundaryFace ( )

default

BoundaryFace() [2/2]

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

Dumux::Experimental::BoundaryFace< GV, T >::BoundaryFace ( const GlobalPosition &  center, const Scalar  area, const GlobalPosition &  normal, const LocalIndexType  localIdx, const LocalIndexType  intersectionIdx, const BoundaryFlag &  bFlag  )

inline

Member Function Documentation

area()

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

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

inline

boundary()

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

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

inline

boundaryFlag()

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

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

inline

center()

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

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

inline

index()

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

LocalIndexType Dumux::Experimental::BoundaryFace< GV, T >::index ( ) const

inline

intersectionIndex()

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

LocalIndexType Dumux::Experimental::BoundaryFace< GV, T >::intersectionIndex ( ) const

inline

unitOuterNormal()

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

const GlobalPosition Dumux::Experimental::BoundaryFace< GV, T >::unitOuterNormal ( ) const

inline

---

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

• boundaryface.hh