Face< GridType > Class Template Reference

Class representing a face. More...

#include <dune/fufem/facehierarchy.hh>

Public Types
typedef GridType::template Codim< 0 >::Entity	Element
typedef GridType::LevelGridView::Intersection	Intersection
typedef GridType::LevelGridView::IntersectionIterator	IntersectionIterator
typedef HierarchicFaceIterator< GridType >	HierarchicIterator
typedef Face< GridType >	FaceType

Public Member Functions
	Face (const GridType &grid, const Element &e, int index=-1)
template<class OtherFace >
	Face (const OtherFace &other)
const Element &	element () const
	Return the element associated with this face.
void	setElement (const Element &e)
	Set the element associated with this face.
int	index () const
	Return the index of the codim=1 subentity associated with this face.
void	setIndex (int i)
	Set the index of the codim=1 subentity associated with this face.
int	level () const
	Return level of the face/associated element.
const GridType &	grid () const
	Return reference to the grid the face belongs to.
bool	isInitialized () const
	Check if face is initialized (index>=0)
HierarchicIterator	hbegin (int maxLevel) const
	Return HierarchicIterator to subfaces.
HierarchicIterator	hend (int maxLevel) const
	Return end of HierarchicIterator to subfaces.
FaceType	father () const
	Return father face.
template<class OtherFace >
bool	isFather (const OtherFace &fatherFace) const
	Check if given face is father face.
template<class OtherFace >
bool	isChild (const OtherFace &childFace) const
	Check for if given face is child face.
IntersectionIterator	intersection () const
	Return a LevelIntersectionIterator associated with this face.
IntersectionIterator	fatherIntersection () const
	Return a LevelIntersectionIterator associated with the father face.

Protected Attributes
const GridType *	grid_
Element	element_
int	index_

Detailed Description

template<class GridType>
class Face< GridType >

Class representing a face.

Template Parameters

GridType

Type of corresponding grid

The face is represented by some 'pointer to Entity<0>' and the index of a codim=1 subentity.

Member Typedef Documentation

Element

template<class GridType >

typedef GridType::template Codim<0>::Entity Face< GridType >::Element

FaceType

template<class GridType >

typedef Face<GridType> Face< GridType >::FaceType

HierarchicIterator

template<class GridType >

typedef HierarchicFaceIterator<GridType> Face< GridType >::HierarchicIterator

Intersection

template<class GridType >

typedef GridType::LevelGridView::Intersection Face< GridType >::Intersection

IntersectionIterator

template<class GridType >

typedef GridType::LevelGridView::IntersectionIterator Face< GridType >::IntersectionIterator

Constructor & Destructor Documentation

Face() [1/2]

template<class GridType >

Face< GridType >::Face ( const GridType &  grid, const Element &  e, int  index = -1  )

inline

Face() [2/2]

template<class GridType >

template<class OtherFace >

Face< GridType >::Face ( const OtherFace< GridType > &  other )

inline

Member Function Documentation

element()

template<class GridType >

const Element & Face< GridType >::element ( ) const

inline

Return the element associated with this face.

father()

template<class GridType >

FaceType Face< GridType >::father ( ) const

inline

Return father face.

Behaviour is undefined if this->element() has no father. If the this->element() has a father but no father face an uninitialized face is returned

fatherIntersection()

template<class GridType >

IntersectionIterator Face< GridType >::fatherIntersection ( ) const

inline

Return a LevelIntersectionIterator associated with the father face.

grid()

template<class GridType >

const GridType & Face< GridType >::grid ( ) const

inline

Return reference to the grid the face belongs to.

hbegin()

template<class GridType >

HierarchicIterator Face< GridType >::hbegin ( int  maxLevel ) const

inline

Return HierarchicIterator to subfaces.

Parameters

maxLevel

The maximal level of subfaces to consider

hend()

template<class GridType >

HierarchicIterator Face< GridType >::hend ( int  maxLevel ) const

inline

Return end of HierarchicIterator to subfaces.

Parameters

maxLevel

The maximal level of subfaces to consider

index()

template<class GridType >

int Face< GridType >::index ( ) const

inline

Return the index of the codim=1 subentity associated with this face.

intersection()

template<class GridType >

IntersectionIterator Face< GridType >::intersection ( ) const

inline

Return a LevelIntersectionIterator associated with this face.

isChild()

template<class GridType >

template<class OtherFace >

bool Face< GridType >::isChild ( const OtherFace< GridType > &  childFace ) const

inline

Check for if given face is child face.

Parameters

childFace

The candidate for being a child face

Check if childFace is a child face of *this.

isFather()

template<class GridType >

template<class OtherFace >

bool Face< GridType >::isFather ( const OtherFace< GridType > &  fatherFace ) const

inline

Check if given face is father face.

Parameters

fatherFace

The candidate for being a father face

Check if fatherFace is the father face of *this.

isInitialized()

template<class GridType >

bool Face< GridType >::isInitialized ( ) const

inline

Check if face is initialized (index>=0)

level()

template<class GridType >

int Face< GridType >::level ( ) const

inline

Return level of the face/associated element.

setElement()

template<class GridType >

void Face< GridType >::setElement ( const Element &  e )

inline

Set the element associated with this face.

setIndex()

template<class GridType >

void Face< GridType >::setIndex ( int  i )

inline

Set the index of the codim=1 subentity associated with this face.

Member Data Documentation

element_

template<class GridType >

Element Face< GridType >::element_

protected

grid_

template<class GridType >

const GridType* Face< GridType >::grid_

protected

index_

template<class GridType >

int Face< GridType >::index_

protected

---

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

• facehierarchy.hh