Dune::GridGlue::Extractor< GV, cd > Class Template Reference

Provides codimension-independent methods for grid extraction. More...

#include <dune/grid-glue/extractors/extractor.hh>

Classes
struct	CornerInfo
	Helpful struct holding one index for the coordinate (vertex) to which it is associated and the element's corner index;. More...
struct	ElementInfo
	simple struct holding an element seed and an index More...
struct	SubEntityInfo
	Holds some information about an element's subentity involved in a coupling. More...
struct	VertexInfo
	simple struct holding a vertex pointer and an index More...

Public Member Functions
	Extractor (const GV &gv)
	Constructor. More...
void	clear ()
	delete everything build up so far and free the memory
void	getCoords (std::vector< Dune::FieldVector< ctype, dimworld > > &coords) const
	getter for the coordinates array More...
unsigned int	nCoords () const
	getter for the count of coordinates More...
void	getGeometryTypes (std::vector< Dune::GeometryType > &geometryTypes) const
	Get the list of geometry types.
void	getFaces (std::vector< VertexVector > &faces) const
	Get the corners of the extracted subentities.
bool	faceIndices (const Element &e, int &first, int &count) const
	gets index of first subentity as well as the total number of subentities that were extracted from this element More...
int	indexInInside (unsigned int index) const
	gets the number face in the parent element More...
const GridView &	gridView () const
	give access to the Dune::GridView where this Patch belongs to
Element	element (unsigned int index) const
	gets the parent element for a given face index, throws an exception if index not valid More...
Vertex	vertex (unsigned int index) const
	gets the vertex for a given coordinate index throws an exception if index not valid More...
Geometry	geometry (unsigned int index) const
	Get world geometry of the extracted face. More...
LocalGeometry	geometryLocal (unsigned int index) const
	Get geometry of the extracted face in element coordinates. More...

Protected Attributes
const GridView	gv_
	the grid object to extract the surface from
std::vector< CoordinateInfo >	coords_
	all information about the corner vertices of the extracted
std::vector< SubEntityInfo >	subEntities_
	all information about the extracted subEntities
VertexInfoMap	vtxInfo_
	a map enabling faster access to vertices and coordinates More...
ElementInfoMap	elmtInfo_
	a map enabling faster access to elements and faces More...

Detailed Description

template<typename GV, int cd>
class Dune::GridGlue::Extractor< GV, cd >

Provides codimension-independent methods for grid extraction.

Template Parameters

GV	the grid view type
cd	codimension of the extracted entities

Constructor & Destructor Documentation

Extractor()

template<typename GV , int cd>

Dune::GridGlue::Extractor< GV, cd >::Extractor ( const GV &  gv )

inline

Constructor.

Parameters

gv	the grid view object to work with

Member Function Documentation

element()

template<typename GV , int cd>

Element Dune::GridGlue::Extractor< GV, cd >::element ( unsigned int  index ) const

inline

gets the parent element for a given face index, throws an exception if index not valid

Parameters

index

the index of the face

Returns

a reference to the element's stored pointer

References Dune::GridGlue::Extractor< GV, cd >::elmtInfo_, and Dune::GridGlue::Extractor< GV, cd >::subEntities_.

faceIndices()

template<typename GV , int cd>

bool Dune::GridGlue::Extractor< GV, cd >::faceIndices ( const Element &  e, int &  first, int &  count  ) const

inline

gets index of first subentity as well as the total number of subentities that were extracted from this element

Parameters

[in]	e	the element
[out]	first	will contain the index of the first subentity if it exists, else -1
[out]	count	will contain the number of subentities extracted from this element

Returns

true if at least one subentity was extracted from this element

References Dune::GridGlue::Extractor< GV, cd >::elmtInfo_.

geometry()

template<typename GV , int cd>

Extractor< GV, cd >::Geometry Dune::GridGlue::Extractor< GV, cd >::geometry

(

unsigned int

index

)

const

Get world geometry of the extracted face.

Get World geometry of the extracted face.

geometryLocal()

template<typename GV , int cd>

Extractor< GV, cd >::LocalGeometry Dune::GridGlue::Extractor< GV, cd >::geometryLocal

(

unsigned int

index

)

const

Get geometry of the extracted face in element coordinates.

Get Geometry of the extracted face in element coordinates.

References Dune::GridGlue::Extractor< GV, cd >::SubEntityInfo::corners, Dune::GridGlue::Extractor< GV, cd >::SubEntityInfo::geometryType_, Dune::GridGlue::Extractor< GV, cd >::CornerInfo::num, and Dune::GridGlue::Extractor< GV, cd >::SubEntityInfo::parent.

getCoords()

template<typename GV , int cd>

void Dune::GridGlue::Extractor< GV, cd >::getCoords ( std::vector< Dune::FieldVector< ctype, dimworld > > &  coords ) const

inline

getter for the coordinates array

Parameters

coords

a vector that will be resized (!) and filled with the coordinates, note that the single components are written consecutively

References Dune::GridGlue::Extractor< GV, cd >::coords_.

indexInInside()

template<typename GV , int cd>

int Dune::GridGlue::Extractor< GV, cd >::indexInInside ( unsigned int  index ) const

inline

gets the number face in the parent element

Parameters

index

the index of the face

Returns

if failed -1, else the index

References Dune::GridGlue::Extractor< GV, cd >::subEntities_.

nCoords()

template<typename GV , int cd>

unsigned int Dune::GridGlue::Extractor< GV, cd >::nCoords ( ) const

inline

getter for the count of coordinates

Returns

the count

References Dune::GridGlue::Extractor< GV, cd >::coords_.

vertex()

template<typename GV , int cd>

Vertex Dune::GridGlue::Extractor< GV, cd >::vertex ( unsigned int  index ) const

inline

gets the vertex for a given coordinate index throws an exception if index not valid

Parameters

index

the index of the coordinate

Returns

a reference to the vertex' stored pointer

References Dune::GridGlue::Extractor< GV, cd >::coords_, and Dune::GridGlue::Extractor< GV, cd >::vtxInfo_.

Member Data Documentation

elmtInfo_

template<typename GV , int cd>

ElementInfoMap Dune::GridGlue::Extractor< GV, cd >::elmtInfo_

protected

a map enabling faster access to elements and faces

Maps an element's index (from index set) to an object holding the locally associated index of its first face in _indices (if there are more they are positioned consecutively) and an entity pointer to the codim<0> entity.

Referenced by Dune::GridGlue::Extractor< GV, cd >::clear(), Dune::GridGlue::Extractor< GV, cd >::element(), and Dune::GridGlue::Extractor< GV, cd >::faceIndices().

vtxInfo_

template<typename GV , int cd>

VertexInfoMap Dune::GridGlue::Extractor< GV, cd >::vtxInfo_

protected

a map enabling faster access to vertices and coordinates

Maps a vertex' index (from index set) to an object holding the locally associated index of the vertex' coordinate in coords_ and an entity pointer to the codim<dim> entity.

Referenced by Dune::GridGlue::Extractor< GV, cd >::clear(), and Dune::GridGlue::Extractor< GV, cd >::vertex().

---

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

• dune/grid-glue/extractors/extractor.hh