Dune::ALU3dGridEntity< 0, dim, GridImp > Class Template Reference

#include <dune/alugrid/3d/entity.hh>

Public Types
typedef GridImp::template Codim< 0 >::EntitySeed	EntitySeed
	typedef of my type

Public Member Functions
	ALU3dGridEntity ()
	Constructor creating empty Entity.
	ALU3dGridEntity (const EntitySeed &seed)
	Constructor taking an EntitySeed.
	ALU3dGridEntity (const HElementType &element)
	Constructor taking an interior Element.
	ALU3dGridEntity (const HBndSegType &ghost)
	Constructor taking a ghost element.
int	level () const
	level of this element
Geometry	geometry () const
	geometry of this entity
GeometryType	type () const
	type of geometry of this entity
PartitionType	partitionType () const
	return partition type of this entity ( see grid.hh )
unsigned int	subEntities (unsigned int codim) const
template<int codim>
Codim< codim >::Entity	subEntity (int i) const
bool	isLeaf () const
	returns true if Entity is leaf (i.e. has no children)
Entity	father () const
bool	hasFather () const
	returns true if father entity exists
LocalGeometry	geometryInFather () const
ALU3dGridHierarchicIterator< GridImp >	hbegin (int maxlevel) const
ALU3dGridHierarchicIterator< GridImp >	hend (int maxlevel) const
	Returns iterator to one past the last son.
bool	isNew () const
	returns true, if entity was created during last adaptation cycle
bool	mightVanish () const
	returns true, if entity might be coarsened during next adaptation cycle
bool	hasBoundaryIntersections () const
	returns true, if entity has intersections with boundary
bool	mark (const int refCount, const bool conformingRefinement) const
int	getMark () const
	return current adaptation mark for this entity
void	setElement (HElementType &element)
void	setGhost (HBndSegType &ghost)
	set original element pointer to fake entity
void	reset (int l)
	set actual walk level
void	removeElement ()
	set item pointer to NULL
bool	equals (const ALU3dGridEntity< 0, dim, GridImp > &org) const
	compare 2 entities, which means compare the item pointers
template<int cc>
int	getSubIndex (int i) const
int	subIndex (int i, unsigned int codim) const
bool	isGhost () const
	returns true if entity is ghost
EntitySeed	seed () const
	return key for this entity
int	macroId () const
	return macro id of this entity
int	weight () const
	weight of entity (ie number of leaf elements underneath)
int	master () const
	return rank number of master process

Static Public Attributes
static constexpr int	codimension
	know your own codimension
static constexpr int	dimension
	Dimension of the grid.
static constexpr int	mydimension
	Know dimension of the entity.

Protected Member Functions
int	getIndex () const
	index is unique within the grid hierachy and per codim

Protected Attributes
GeometryImpl	geo_
	the entity's geometry
BNDFaceType *	ghost_
	not zero if entity is ghost entity

Detailed Description

template<int dim, class GridImp>
class Dune::ALU3dGridEntity< 0, dim, GridImp >

A Grid is a container of grid entities. An entity is parametrized by the codimension. An entity of codimension c in dimension d is a d-c dimensional object.

Entities of codimension 0 ("elements") are defined through template specialization. Note that this specialization has an extended interface compared to the general case

Entities of codimension 0 allow to visit all neighbors, where a neighbor is an entity of codimension 0 which has a common entity of codimension 1 with the These neighbors are accessed via an iterator. This allows the implementation of non-matching meshes. The number of neigbors may be different from the number of faces/edges of an element!

Member Function Documentation

father()

template<int dim, class GridImp >

ALU3dGridEntity< 0, dim, GridImp >::Entity Dune::ALU3dGridEntity< 0, dim, GridImp >::father

Inter-level access to father element on coarser grid. Assumes that meshes are nested.

References Dune::ALU3dGridEntity< cd, dim, GridImp >::getIndex().

geometryInFather()

template<int dim, class GridImp >

alu_inline ALU3dGridEntity< 0, dim, GridImp >::LocalGeometry Dune::ALU3dGridEntity< 0, dim, GridImp >::geometryInFather

Location of this element relative to the reference element of the father. This is sufficient to interpolate all dofs in conforming case. Nonconforming may require access to neighbors of father and computations with local coordinates. On the fly case is somewhat inefficient since dofs are visited several times. If we store interpolation matrices, this is tolerable. We assume that on-the-fly implementation of numerical algorithms is only done for simple discretizations. Assumes that meshes are nested.

References Dune::TypeTree::child(), Dune::ALU3dGridEntity< cd, dim, GridImp >::geometry(), and Dune::ALU3dGridEntity< cd, dim, GridImp >::type().

getSubIndex()

template<int dim, class GridImp >

template<int cc>

int Dune::ALU3dGridEntity< 0, dim, GridImp >::getSubIndex

(

int

i

)

const

return index of sub entity with codim = cc and local number i i.e. return global number of vertex i for use in hierarchical index set

hbegin()

template<int dim, class GridImp >

alu_inline ALU3dGridHierarchicIterator< GridImp > Dune::ALU3dGridEntity< 0, dim, GridImp >::hbegin

(

int

maxlevel

)

const

Inter-level access to son elements on higher levels<=maxlevel. This is provided for sparsely stored nested unstructured meshes. Returns iterator to first son.

mark()

template<int dim, class GridImp >

bool Dune::ALU3dGridEntity< 0, dim, GridImp >::mark	(	const int	refCount,
		const bool	conformingRefinement
	)		const

marks an element for refCount refines. if refCount is negative the element is coarsend -refCount times mark returns true if element was marked, otherwise false

References Dune::ALU3dGridEntity< cd, dim, GridImp >::level().

setElement()

template<int dim, class GridImp >

alu_inline void Dune::ALU3dGridEntity< 0, dim, GridImp >::setElement

(

HElementType &

element

)

private methods, but public because of datahandle and template arguments of these methods

References Dune::ALU3dGridEntity< cd, dim, GridImp >::geo_.

subEntities()

template<int dim, class GridImp >

alu_inline unsigned int Dune::ALU3dGridEntity< 0, dim, GridImp >::subEntities

(

unsigned int

codim

)

const

Intra-element access to entities of codimension cc > codim. Return number of entities with codimension cc.

References Dune::referenceElement().

subEntity()

template<int dim, class GridImp >

template<int codim>

Codim< codim >::Entity Dune::ALU3dGridEntity< 0, dim, GridImp >::subEntity

(

int

i

)

const

Provide access to mesh entity i of given codimension. Entities are numbered 0 ... subEntities(codim)-1

subIndex()

template<int dim, class GridImp >

alu_inline int Dune::ALU3dGridEntity< 0, dim, GridImp >::subIndex	(	int	i,
		unsigned int	codim
	)		const

return index of sub entity with codim = cc and local number i i.e. return global number of vertex i for use in hierarchical index set

References Dune::ALU3dGridEntity< cd, dim, GridImp >::getIndex().

---

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

• dune/alugrid/3d/entity.hh
• dune/alugrid/3d/entity_imp.cc