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

Inheritance diagram for Dune::GridGlue::Codim0Extractor< GV >:

Public Types
typedef Extractor< GV, 0 >::ctype	ctype
typedef Extractor< GV, 0 >::IndexType	IndexType
typedef GV::Traits::template Codim< dim >::Entity	Vertex
typedef GV::Traits::template Codim< 0 >::Entity	Element
typedef std::function< bool(const Element &, unsigned int subentity)>	Predicate
typedef Extractor< GV, 0 >::SubEntityInfo	SubEntityInfo
typedef Extractor< GV, 0 >::ElementInfo	ElementInfo
typedef Extractor< GV, 0 >::VertexInfo	VertexInfo
typedef Extractor< GV, 0 >::CoordinateInfo	CoordinateInfo
typedef Extractor< GV, 0 >::VertexInfoMap	VertexInfoMap
typedef GV	GridView
typedef GridView::Grid	Grid
typedef Dune::FieldVector< ctype, dimworld >	Coords
typedef Dune::FieldVector< ctype, dim >	LocalCoords
typedef Vertex::EntitySeed	VertexSeed
typedef Element::EntitySeed	ElementSeed
typedef std::vector< unsigned int >	VertexVector
using	CellMapper
typedef Dune::MultiLinearGeometry< ctype, dim-codim, dimworld >	Geometry
typedef Dune::MultiLinearGeometry< ctype, dim-codim, dim >	LocalGeometry

Public Member Functions
	Codim0Extractor (const GV &gv, const Predicate &predicate)
	Constructor.
bool &	positiveNormalDirection ()
const bool &	positiveNormalDirection () const
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
unsigned int	nCoords () const
	getter for the count of coordinates
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
int	indexInInside (unsigned int index) const
	gets the number face in the parent element
const GridView &	gridView () const
	tests that a given entry in the extraction set does have local couplings
const Grid &	grid () const
Element	element (unsigned int index) const
	gets the parent element for a given face index, throws an exception if index not valid
Vertex	vertex (unsigned int index) const
	gets the vertex for a given coordinate index throws an exception if index not valid
Geometry	geometry (unsigned int index) const
	Get world geometry of the extracted face.
LocalGeometry	geometryLocal (unsigned int index) const
	Get geometry of the extracted face in element coordinates.

Static Public Attributes
static constexpr auto	dimworld
static constexpr auto	dim
static constexpr auto	codim
static constexpr int	cube_corners

Protected Types
typedef std::map< IndexType, ElementInfo >	ElementInfoMap

Protected Attributes
bool	positiveNormalDirection_
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
ElementInfoMap	elmtInfo_
	a map enabling faster access to elements and faces
CellMapper	cellMapper_

Detailed Description

template<typename GV>
class Dune::GridGlue::Codim0Extractor< GV >

extractor for codim-0 entities (elements)

Member Typedef Documentation

◆ CellMapper

using Dune::GridGlue::Extractor< GV, cd >::CellMapper

inherited

◆ CoordinateInfo

template<typename GV>

typedef Extractor<GV,0>::CoordinateInfo Dune::GridGlue::Codim0Extractor< GV >::CoordinateInfo

◆ Coords

typedef Dune::FieldVector<ctype, dimworld> Dune::GridGlue::Extractor< GV, cd >::Coords

inherited

◆ ctype

template<typename GV>

typedef Extractor<GV,0>::ctype Dune::GridGlue::Codim0Extractor< GV >::ctype

◆ Element

template<typename GV>

typedef GV::Traits::template Codim<0>::Entity Dune::GridGlue::Codim0Extractor< GV >::Element

◆ ElementInfo

template<typename GV>

typedef Extractor<GV,0>::ElementInfo Dune::GridGlue::Codim0Extractor< GV >::ElementInfo

◆ ElementInfoMap

typedef std::map<IndexType, ElementInfo> Dune::GridGlue::Extractor< GV, cd >::ElementInfoMap

protectedinherited

◆ ElementSeed

typedef Element::EntitySeed Dune::GridGlue::Extractor< GV, cd >::ElementSeed

inherited

◆ Geometry

typedef Dune::MultiLinearGeometry<ctype, dim-codim, dimworld> Dune::GridGlue::Extractor< GV, cd >::Geometry

inherited

◆ Grid

typedef GridView::Grid Dune::GridGlue::Extractor< GV, cd >::Grid

inherited

◆ GridView

typedef GV Dune::GridGlue::Extractor< GV, cd >::GridView

inherited

◆ IndexType

template<typename GV>

typedef Extractor<GV,0>::IndexType Dune::GridGlue::Codim0Extractor< GV >::IndexType

◆ LocalCoords

typedef Dune::FieldVector<ctype, dim> Dune::GridGlue::Extractor< GV, cd >::LocalCoords

inherited

◆ LocalGeometry

typedef Dune::MultiLinearGeometry<ctype, dim-codim, dim> Dune::GridGlue::Extractor< GV, cd >::LocalGeometry

inherited

◆ Predicate

template<typename GV>

typedef std::function<bool(const Element&, unsigned int subentity)> Dune::GridGlue::Codim0Extractor< GV >::Predicate

◆ SubEntityInfo

template<typename GV>

typedef Extractor<GV,0>::SubEntityInfo Dune::GridGlue::Codim0Extractor< GV >::SubEntityInfo

◆ Vertex

template<typename GV>

typedef GV::Traits::template Codim<dim>::Entity Dune::GridGlue::Codim0Extractor< GV >::Vertex

◆ VertexInfo

template<typename GV>

typedef Extractor<GV,0>::VertexInfo Dune::GridGlue::Codim0Extractor< GV >::VertexInfo

◆ VertexInfoMap

template<typename GV>

typedef Extractor<GV,0>::VertexInfoMap Dune::GridGlue::Codim0Extractor< GV >::VertexInfoMap

◆ VertexSeed

typedef Vertex::EntitySeed Dune::GridGlue::Extractor< GV, cd >::VertexSeed

inherited

◆ VertexVector

typedef std::vector<unsigned int> Dune::GridGlue::Extractor< GV, cd >::VertexVector

inherited

Constructor & Destructor Documentation

◆ Codim0Extractor()

template<typename GV>

Dune::GridGlue::Codim0Extractor< GV >::Codim0Extractor	(	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

◆ clear()

void Dune::GridGlue::Extractor< GV, cd >::clear ( )

inlineinherited

delete everything build up so far and free the memory

◆ 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

◆ getFaces()

void Dune::GridGlue::Extractor< GV, cd >::getFaces ( std::vector< VertexVector > & faces ) const

inlineinherited

Get the corners of the extracted subentities.

◆ getGeometryTypes()

void Dune::GridGlue::Extractor< GV, cd >::getGeometryTypes ( std::vector< Dune::GeometryType > & geometryTypes ) const

inlineinherited

Get the list of geometry types.

◆ grid()

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

inlineinherited

◆ gridView()

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

inlineinherited

tests that a given entry in the extraction set does have local couplings

Todo: parallel interface

give access to the Dune::GridView where this Patch belongs to

◆ 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

◆ positiveNormalDirection() [1/2]

template<typename GV>

bool & Dune::GridGlue::Codim0Extractor< GV >::positiveNormalDirection ( )

inline

◆ positiveNormalDirection() [2/2]

template<typename GV>

const bool & Dune::GridGlue::Codim0Extractor< GV >::positiveNormalDirection ( ) const

inline

◆ 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

◆ cellMapper_

CellMapper Dune::GridGlue::Extractor< GV, cd >::cellMapper_

protectedinherited

◆ codim

auto Dune::GridGlue::Extractor< GV, cd >::codim

staticconstexprinherited

◆ coords_

std::vector<CoordinateInfo> Dune::GridGlue::Extractor< GV, cd >::coords_

protectedinherited

all information about the corner vertices of the extracted

◆ cube_corners

int Dune::GridGlue::Extractor< GV, cd >::cube_corners

staticconstexprinherited

◆ dim

auto Dune::GridGlue::Extractor< GV, cd >::dim

staticconstexprinherited

◆ dimworld

auto Dune::GridGlue::Extractor< GV, cd >::dimworld

staticconstexprinherited

◆ 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.

◆ gv_

const GridView Dune::GridGlue::Extractor< GV, cd >::gv_

protectedinherited

the grid object to extract the surface from

◆ positiveNormalDirection_

template<typename GV>

bool Dune::GridGlue::Codim0Extractor< GV >::positiveNormalDirection_

protected

◆ subEntities_

std::vector<SubEntityInfo> Dune::GridGlue::Extractor< GV, cd >::subEntities_

protectedinherited

all information about the extracted subEntities

◆ 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:

codim0extractor.hh

Public Types

Public Member Functions

Static Public Attributes

Protected Types

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CellMapper

◆ CoordinateInfo

◆ Coords

◆ ctype

◆ Element

◆ ElementInfo

◆ ElementInfoMap

◆ ElementSeed

◆ Geometry

◆ Grid

◆ GridView

◆ IndexType

◆ LocalCoords

◆ LocalGeometry

◆ Predicate

◆ SubEntityInfo

◆ Vertex

◆ VertexInfo

◆ VertexInfoMap

◆ VertexSeed

◆ VertexVector

Constructor & Destructor Documentation

◆ Codim0Extractor()

Member Function Documentation

◆ clear()

◆ element()

◆ faceIndices()

◆ geometry()

◆ geometryLocal()

◆ getCoords()

◆ getFaces()

◆ getGeometryTypes()

◆ grid()

◆ gridView()

◆ indexInInside()

◆ nCoords()

◆ positiveNormalDirection() [1/2]

◆ positiveNormalDirection() [2/2]

◆ vertex()

Member Data Documentation

◆ cellMapper_

◆ codim

◆ coords_

◆ cube_corners

◆ dim

◆ dimworld

◆ elmtInfo_

◆ gv_

◆ positiveNormalDirection_

◆ subEntities_

◆ vtxInfo_