Dune::GridGlue::Codim1Extractor< GV > Class Template Reference

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

Public Member Functions
	Codim1Extractor (const GV &gv, const Predicate &predicate)
	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...

Static Public Attributes
static constexpr int	simplex_corners = dim
	compile time number of corners of surface simplices

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>
class Dune::GridGlue::Codim1Extractor< GV >

extractor for codim-1 entities (facets)

Constructor & Destructor Documentation

Codim1Extractor()

template<typename GV >

Dune::GridGlue::Codim1Extractor< GV >::Codim1Extractor ( const GV &  gv, const Predicate &  predicate  )

inline

Constructor.

Parameters

gv	the grid view object to work with
predicate	a predicate to mark entities for extraction (unary functor returning bool)

Member Function Documentation

element()

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

inlineinherited

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

faceIndices()

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

inlineinherited

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

geometry()

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

inherited

Get world geometry of the extracted face.

Get World geometry of the extracted face.

geometryLocal()

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

inherited

Get geometry of the extracted face in element coordinates.

Get Geometry of the extracted face in element coordinates.

getCoords()

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

inlineinherited

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

indexInInside()

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

inlineinherited

gets the number face in the parent element

Parameters

index

the index of the face

Returns

if failed -1, else the index

nCoords()

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

inlineinherited

getter for the count of coordinates

Returns

the count

vertex()

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

inlineinherited

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

Member Data Documentation

elmtInfo_

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

protectedinherited

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.

vtxInfo_

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

protectedinherited

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.

---

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

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