#include <Entity.hpp>

Inheritance diagram for Dune::cpgrid::Entity< codim >:

Classes
struct	Codim
	Export supported entity types. More...

Public Types
typedef Entity	EntitySeed

typedef cpgrid::Geometry< 3-codim, 3 >	Geometry

typedef Geometry	LocalGeometry

typedef cpgrid::IntersectionIterator	LeafIntersectionIterator

typedef cpgrid::IntersectionIterator	LevelIntersectionIterator

typedef cpgrid::HierarchicIterator	HierarchicIterator

typedef double	ctype

enum	{ codimension =codim }

enum	{ InvalidIndex = INT_MAX }

Public Member Functions
	Entity ()
	Constructor creating empty entity. More...

	Entity (const CpGridData &grid, EntityRep< codim > entityrep)
	Constructor taking a grid and an entity representation. More...

	Entity (const CpGridData &grid, int index_arg, bool orientation_arg)
	Constructor taking a grid, entity index, and orientation. More...

	Entity (int index_arg, bool orientation_arg)
	Constructor taking a entity index, and orientation. More...

bool	operator== (const Entity &other) const
	Equality. More...

bool	operator!= (const Entity &other) const
	Inequality. More...

EntitySeed	seed () const
	Return an entity seed (light-weight entity). EntitySeed objects are used to obtain an Entity back when combined with the corresponding grid. For CpGrid, EntitySeed and EntityPtr are the same class. More...

const Geometry &	geometry () const
	Return the geometry of the entity (does not depend on its orientation). More...

int	level () const
	Return the level of the entity in the grid hierarchy. Level = 0 represents the coarsest grid. More...

bool	isLeaf () const
	Check if the entity is in the leafview. More...

bool	isRegular () const
	Refinement is not defined for CpGrid. More...

PartitionType	partitionType () const
	In serial run, the only partitionType() is InteriorEntity. Only needed when distributed_data_ is not empty. In parallel run, the entity each cell inherits the partition type of its origin (either parent cell or equivalent cell in level 0). Only needed when distributed_data_ is not empty. More...

GeometryType	type () const
	Return marker object (GeometryType object) representing the reference element of the entity. Currently, cube type for all entities (cells and vertices). More...

unsigned int	subEntities (const unsigned int cc) const
	Return the number of all subentities of the entity of a given codimension cc. More...

template<int cc>
Codim< cc >::Entity	subEntity (int i) const
	Obtain subentity. Example: If cc = 3 and i = 5, it returns the 5th corner/vertex of the entity. More...

LevelIntersectionIterator	ilevelbegin () const
	Start level-iterator for the cell-cell intersections of this entity. More...

LevelIntersectionIterator	ilevelend () const
	End level-iterator for the cell-cell intersections of this entity. More...

LeafIntersectionIterator	ileafbegin () const
	Start leaf-iterator for the cell-cell intersections of this entity. More...

LeafIntersectionIterator	ileafend () const
	End leaf-iterator for the cell-cell intersections of this entity. More...

HierarchicIterator	hbegin (int) const
	Iterator begin over the children. [If requested, also over descendants more than one generation away.]. More...

HierarchicIterator	hend (int) const
	Iterator end over the children/beyond last child iterator. More...

bool	isNew () const
	Returns true, if the entity has been created during the last call to adapt(). More...

bool	mightVanish () const
	Indicates whether the entity may be removed in the next call to adapt(). More...

bool	hasFather () const
	ONLY FOR CELLS (Entity<0>) Check if the entity comes from an LGR, i.e., it has been created via refinement from coarser level. More...

Entity< 0 >	father () const
	ONLY FOR CELLS (Entity<0>). Get the father Entity (in the level-grid the father cell was born), in case entity.hasFather() is true. More...

Dune::cpgrid::Geometry< 3, 3 >	geometryInFather () const
	Return LocalGeometry representing the embedding of the entity into its father (when hasFather() is true). Map from the entity's reference element into the reference element of its father. Currently, LGR is built via refinement of a block-shaped patch from the coarse grid. So the LocalGeometry of an entity coming from the LGR is one of the refined cells of the unit cube, with suitable amount of cells in each direction. More...

bool	hasBoundaryIntersections () const

const Entity &	impl () const
	Access the actual implementation class behind Entity interface class. More...

Entity &	impl ()

bool	isValid () const

Entity< 0 >	getOrigin () const
	Returns (1) oldest ancestor, i.e., oldest parent entity in the level-grid 0, if the entity was born in any refined level grid with level>0. (2) if the entity has no father, and is a leaf-grid-view entity, it returns the equivalent element on the level that it was born. Namely, for coarse cells on the leaf never involved in any refinement process, we get the equivalent entity in the GLOBAL grid (level 0). (3) Otherwise, returns itself, which means that its grid is the level 0 and the entity itself is already its "origin". More...

Entity< 0 >	getLevelElem () const
	Get equivalent element on the level grid where the entity was born, if grid = leaf-grid-view. Otherwise, return itself. More...

int	getLevelCartesianIdx () const
	Get Cartesian Index in the level grid view where the Entity was born. More...

int	getIdxInParentCell () const

template<int cc>
Entity< codim >::template Codim< cc >::Entity	subEntity (int i) const

void	setValue (int index_arg, bool orientation_arg)
	Set entity value. More...

int	index () const
	The (positive) index of an entity. Not a Dune interface method. More...

int	signedIndex () const
	The signed index that also tells us the orientation. More...

bool	orientation () const
	Returns true if the entity has positive orientation. Not a Dune interface method. More...

EntityRep	opposite () const
	Returns an EntityRep with opposite orientation. More...

void	increment ()
	Increments the entityrep's index() by one. More...

bool	operator< (const EntityRep &other) const
	Ordering relation used for maps etc. More...

bool	operator== (const EntityRep &other) const
	Equality operator. More...

bool	operator!= (const EntityRep &other) const
	Inequality operator. More...

Static Public Attributes
static constexpr int	codimension = codim

static constexpr int	dimension = 3

static constexpr int	mydimension = dimension - codimension

static constexpr int	dimensionworld = 3

Protected Attributes
const CpGridData *	pgrid_

Friends
class	LevelGlobalIdSet

class	GlobalIdSet

class	HierarchicIterator

class	CpGridData

Detailed Description

template<int codim>
class Dune::cpgrid::Entity< codim >

Template Parameters

Member Typedef Documentation

◆ ctype

template<int codim>

typedef double Dune::cpgrid::Entity< codim >::ctype

◆ EntitySeed

template<int codim>

typedef Entity Dune::cpgrid::Entity< codim >::EntitySeed

◆ Geometry

template<int codim>

typedef cpgrid::Geometry<3-codim,3> Dune::cpgrid::Entity< codim >::Geometry

◆ HierarchicIterator

template<int codim>

typedef cpgrid::HierarchicIterator Dune::cpgrid::Entity< codim >::HierarchicIterator

◆ LeafIntersectionIterator

template<int codim>

typedef cpgrid::IntersectionIterator Dune::cpgrid::Entity< codim >::LeafIntersectionIterator

◆ LevelIntersectionIterator

template<int codim>

typedef cpgrid::IntersectionIterator Dune::cpgrid::Entity< codim >::LevelIntersectionIterator

◆ LocalGeometry

template<int codim>

typedef Geometry Dune::cpgrid::Entity< codim >::LocalGeometry

Member Enumeration Documentation

◆ anonymous enum

template<int codim>

anonymous enum

inherited

Enumerator
codimension

◆ anonymous enum

template<int codim>

anonymous enum

inherited

Enumerator
InvalidIndex

Constructor & Destructor Documentation

◆ Entity() [1/4]

template<int codim>

Dune::cpgrid::Entity< codim >::Entity ( )

inline

Constructor creating empty entity.

Constructor taking a grid and an integer entity representation. This constructor should probably be removed, since it exposes details of the implementation of

See also: EntityRep, see comment in EntityRep<>::EntityRep(int).

◆ Entity() [2/4]

template<int codim>

Dune::cpgrid::Entity< codim >::Entity	(	const CpGridData &	grid,
		EntityRep< codim >	entityrep
	)

inline

Constructor taking a grid and an entity representation.

◆ Entity() [3/4]

template<int codim>

Dune::cpgrid::Entity< codim >::Entity	(	const CpGridData &	grid,
		int	index_arg,
		bool	orientation_arg
	)

inline

Constructor taking a grid, entity index, and orientation.

◆ Entity() [4/4]

template<int codim>

Dune::cpgrid::Entity< codim >::Entity	(	int	index_arg,
		bool	orientation_arg
	)

inline

Constructor taking a entity index, and orientation.

Member Function Documentation

◆ father()

template<int codim>

Entity< 0 > Dune::cpgrid::Entity< codim >::father

ONLY FOR CELLS (Entity<0>). Get the father Entity (in the level-grid the father cell was born), in case entity.hasFather() is true.

Returns: father-entity

◆ geometry()

template<int codim>

const Entity< codim >::Geometry & Dune::cpgrid::Entity< codim >::geometry

Return the geometry of the entity (does not depend on its orientation).

◆ geometryInFather()

template<int codim>

Dune::cpgrid::Geometry< 3, 3 > Dune::cpgrid::Entity< codim >::geometryInFather

Return LocalGeometry representing the embedding of the entity into its father (when hasFather() is true). Map from the entity's reference element into the reference element of its father. Currently, LGR is built via refinement of a block-shaped patch from the coarse grid. So the LocalGeometry of an entity coming from the LGR is one of the refined cells of the unit cube, with suitable amount of cells in each direction.

◆ getIdxInParentCell()

template<int codim>

int Dune::cpgrid::Entity< codim >::getIdxInParentCell

◆ getLevelCartesianIdx()

template<int codim>

int Dune::cpgrid::Entity< codim >::getLevelCartesianIdx

Get Cartesian Index in the level grid view where the Entity was born.

◆ getLevelElem()

template<int codim>

Dune::cpgrid::Entity< 0 > Dune::cpgrid::Entity< codim >::getLevelElem

Get equivalent element on the level grid where the entity was born, if grid = leaf-grid-view. Otherwise, return itself.

◆ getOrigin()

template<int codim>

Dune::cpgrid::Entity< 0 > Dune::cpgrid::Entity< codim >::getOrigin

Returns (1) oldest ancestor, i.e., oldest parent entity in the level-grid 0, if the entity was born in any refined level grid with level>0. (2) if the entity has no father, and is a leaf-grid-view entity, it returns the equivalent element on the level that it was born. Namely, for coarse cells on the leaf never involved in any refinement process, we get the equivalent entity in the GLOBAL grid (level 0). (3) Otherwise, returns itself, which means that its grid is the level 0 and the entity itself is already its "origin".

◆ hasBoundaryIntersections()

template<int codim>

bool Dune::cpgrid::Entity< codim >::hasBoundaryIntersections

Returns true if any of my intersections are on the boundary. Implementation note: This is a slow, computed, function. Could be speeded up by putting boundary info in the CpGrid class.

◆ hasFather()

template<int codim>

bool Dune::cpgrid::Entity< codim >::hasFather

ONLY FOR CELLS (Entity<0>) Check if the entity comes from an LGR, i.e., it has been created via refinement from coarser level.

@TODO: When distributed_data_ is not empty, check whether the father element exists on the local process, which can be used to test whether it is safe to call father.

◆ hbegin()

template<int codim>

HierarchicIterator Dune::cpgrid::Entity< codim >::hbegin ( int maxLevel ) const

Iterator begin over the children. [If requested, also over descendants more than one generation away.].

◆ hend()

template<int codim>

HierarchicIterator Dune::cpgrid::Entity< codim >::hend ( int maxLevel ) const

Iterator end over the children/beyond last child iterator.

Dummy beyond last child iterator.

◆ ileafbegin()

template<int codim>

Entity< codim >::LeafIntersectionIterator Dune::cpgrid::Entity< codim >::ileafbegin

inline

Start leaf-iterator for the cell-cell intersections of this entity.

◆ ileafend()

template<int codim>

Entity< codim >::LeafIntersectionIterator Dune::cpgrid::Entity< codim >::ileafend

inline

End leaf-iterator for the cell-cell intersections of this entity.

◆ ilevelbegin()

template<int codim>

Entity< codim >::LevelIntersectionIterator Dune::cpgrid::Entity< codim >::ilevelbegin

inline

Start level-iterator for the cell-cell intersections of this entity.

◆ ilevelend()

template<int codim>

Entity< codim >::LevelIntersectionIterator Dune::cpgrid::Entity< codim >::ilevelend

inline

End level-iterator for the cell-cell intersections of this entity.

◆ impl() [1/2]

template<int codim>

Entity & Dune::cpgrid::Entity< codim >::impl ( )

inline

◆ impl() [2/2]

template<int codim>

const Entity & Dune::cpgrid::Entity< codim >::impl ( ) const

inline

Access the actual implementation class behind Entity interface class.

Referenced by Dune::cpgrid::Entity< codim >::seed().

◆ increment()

template<int codim>

void Dune::cpgrid::EntityRep< codim >::increment ( )

inlineinherited

Increments the entityrep's index() by one.

Referenced by Dune::cpgrid::Iterator< cd, pitype >::Iterator(), and Dune::cpgrid::Iterator< cd, pitype >::operator++().

◆ index()

template<int codim>

int Dune::cpgrid::EntityRep< codim >::index ( ) const

inlineinherited

The (positive) index of an entity. Not a Dune interface method.

Returns: the (positive) index of an entity.

Referenced by Dune::cpgrid::PointViaCellHandleWrapper< Handle >::gather(), Dune::cpgrid::Intersection::id(), Dune::cpgrid::LevelGlobalIdSet::id(), Dune::cpgrid::IndexSet::index(), Dune::cpgrid::Entity< codim >::isValid(), Dune::cpgrid::Iterator< cd, pitype >::Iterator(), Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::makeInverseRelation(), Dune::cpgrid::Iterator< cd, pitype >::operator++(), Dune::cpgrid::EntityRep< codim >::operator<(), Dune::cpgrid::EntityVariable< T, codim >::operator[](), Dune::cpgrid::SignedEntityVariable< T, codim >::operator[](), Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::operator[](), Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::printRelationMatrix(), Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::row(), Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::rowSize(), Dune::cpgrid::PointViaCellHandleWrapper< Handle >::scatter(), and Dune::cpgrid::PointViaCellHandleWrapper< Handle >::size().

◆ isLeaf()

template<int codim>

bool Dune::cpgrid::Entity< codim >::isLeaf

Check if the entity is in the leafview.

   @TODO: Modify the definition to cover serial and parallel cases.
   Serial: an element is a leaf <-> hbegin and hend return the same iterator
   Parallel: true <-> the element is a leaf entity of the global refinement hierarchy.

◆ isNew()

template<int codim>

bool Dune::cpgrid::Entity< codim >::isNew

Returns true, if the entity has been created during the last call to adapt().

Note: An element created during the last refinement step may still be refined further on a higher level (e.g., through nested refinement). The isNew flag is used to identify such newly created elements so that data interpolation is applied only to them.

◆ isRegular()

template<int codim>

bool Dune::cpgrid::Entity< codim >::isRegular ( ) const

inline

Refinement is not defined for CpGrid.

◆ isValid()

template<int codim>

bool Dune::cpgrid::Entity< codim >::isValid

isValid method for EntitySeed

Returns: return true if seed is pointing to a valid entity

References Dune::cpgrid::EntityRep< codim >::index().

Referenced by Dune::cpgrid::HierarchicIterator::operator*(), and Dune::cpgrid::HierarchicIterator::operator->().

◆ level()

template<int codim>

int Dune::cpgrid::Entity< codim >::level

Return the level of the entity in the grid hierarchy. Level = 0 represents the coarsest grid.

◆ mightVanish()

template<int codim>

bool Dune::cpgrid::Entity< codim >::mightVanish

Indicates whether the entity may be removed in the next call to adapt().

For CpGrid, this currently always returns false, since only refinement (and no coarsening) is supported. A return value of false guarantees that the entity will still exist after adaptation.

◆ operator!=() [1/2]

template<int codim>

bool Dune::cpgrid::Entity< codim >::operator!= ( const Entity< codim > & other ) const

inline

Inequality.

References Dune::cpgrid::Entity< codim >::operator==().

◆ operator!=() [2/2]

template<int codim>

bool Dune::cpgrid::EntityRep< codim >::operator!= ( const EntityRep< codim > & other ) const

inlineinherited

Inequality operator.

Parameters

other The other entity representation.

Returns: true if this and the other element are not equal.

References Dune::cpgrid::EntityRep< codim >::operator==().

◆ operator<()

template<int codim>

bool Dune::cpgrid::EntityRep< codim >::operator< ( const EntityRep< codim > & other ) const

inlineinherited

Ordering relation used for maps etc.

Sorting on index and then orientation, with positive orientations first.

Parameters

other The other entity representation.

Returns: true if this element is less than the other.

References Dune::cpgrid::EntityRep< codim >::index(), and Dune::cpgrid::EntityRep< codim >::orientation().

◆ operator==() [1/2]

template<int codim>

bool Dune::cpgrid::Entity< codim >::operator== ( const Entity< codim > & other ) const

inline

Equality.

References Dune::cpgrid::EntityRep< codim >::operator==(), and Dune::cpgrid::Entity< codim >::pgrid_.

Referenced by Dune::cpgrid::Entity< codim >::operator!=().

◆ operator==() [2/2]

template<int codim>

bool Dune::cpgrid::EntityRep< codim >::operator== ( const EntityRep< codim > & other ) const

inlineinherited

Equality operator.

Parameters

other The other entity representation.

Returns: true if this and the other element are equal.

Referenced by Dune::cpgrid::EntityRep< codim >::operator!=(), and Dune::cpgrid::Entity< codim >::operator==().

◆ opposite()

template<int codim>

EntityRep Dune::cpgrid::EntityRep< codim >::opposite ( ) const

inlineinherited

Returns an EntityRep with opposite orientation.

Returns: an EntityRep with opposite orientation.

References Dune::cpgrid::EntityRep< codim >::EntityRep().

Referenced by Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::makeInverseRelation(), Dune::cpgrid::OrientedEntityRange< codim_to >::operator[](), and Dune::cpgrid::MutableOrientedEntityRange< codim_to >::operator[]().

◆ orientation()

template<int codim>

bool Dune::cpgrid::EntityRep< codim >::orientation ( ) const

inlineinherited

Returns true if the entity has positive orientation. Not a Dune interface method.

Returns: true if the entity has positive orientation.

Referenced by Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::makeInverseRelation(), Dune::cpgrid::EntityRep< codim >::operator<(), Dune::cpgrid::SignedEntityVariable< T, codim >::operator[](), Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::operator[](), and Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::printRelationMatrix().

◆ partitionType()

template<int codim>

PartitionType Dune::cpgrid::Entity< codim >::partitionType

In serial run, the only partitionType() is InteriorEntity. Only needed when distributed_data_ is not empty. In parallel run, the entity each cell inherits the partition type of its origin (either parent cell or equivalent cell in level 0). Only needed when distributed_data_ is not empty.

Referenced by Dune::cpgrid::PartitionIteratorRule< Interior_Partition >::isInvalid(), Dune::cpgrid::PartitionIteratorRule< InteriorBorder_Partition >::isInvalid(), and Dune::cpgrid::PartitionIteratorRule< Overlap_Partition >::isInvalid().

◆ seed()

template<int codim>

EntitySeed Dune::cpgrid::Entity< codim >::seed ( ) const

inline

Return an entity seed (light-weight entity). EntitySeed objects are used to obtain an Entity back when combined with the corresponding grid. For CpGrid, EntitySeed and EntityPtr are the same class.

References Dune::cpgrid::Entity< codim >::impl().

◆ setValue()

template<int codim>

void Dune::cpgrid::EntityRep< codim >::setValue	(	int	index_arg,
		bool	orientation_arg
	)

inlineinherited

Set entity value.

Parameters

index_arg	Entity index
orientation_arg	True if the entity's orientation is positive.

◆ signedIndex()

template<int codim>

int Dune::cpgrid::EntityRep< codim >::signedIndex ( ) const

inlineinherited

The signed index that also tells us the orientation.

◆ subEntities()

template<int codim>

unsigned int Dune::cpgrid::Entity< codim >::subEntities ( const unsigned int cc ) const

Return the number of all subentities of the entity of a given codimension cc.

◆ subEntity() [1/2]

template<int codim>

template<int cc>

Codim< cc >::Entity Dune::cpgrid::Entity< codim >::subEntity ( int i ) const

Obtain subentity. Example: If cc = 3 and i = 5, it returns the 5th corner/vertex of the entity.

◆ subEntity() [2/2]

template<int codim>

template<int cc>

Entity< codim >::template Codim< cc >::Entity Dune::cpgrid::Entity< codim >::subEntity ( int i ) const

◆ type()

template<int codim>

GeometryType Dune::cpgrid::Entity< codim >::type ( ) const

inline

Return marker object (GeometryType object) representing the reference element of the entity. Currently, cube type for all entities (cells and vertices).

Friends And Related Function Documentation

◆ CpGridData

template<int codim>

friend class CpGridData

friend

◆ GlobalIdSet

template<int codim>

friend class GlobalIdSet

friend

◆ HierarchicIterator

template<int codim>

friend class HierarchicIterator

friend

◆ LevelGlobalIdSet

template<int codim>

friend class LevelGlobalIdSet

friend

Member Data Documentation

◆ codimension

template<int codim>

constexpr int Dune::cpgrid::Entity< codim >::codimension = codim

staticconstexpr

◆ dimension

template<int codim>

constexpr int Dune::cpgrid::Entity< codim >::dimension = 3

staticconstexpr

◆ dimensionworld

template<int codim>

constexpr int Dune::cpgrid::Entity< codim >::dimensionworld = 3

staticconstexpr

◆ mydimension

template<int codim>

constexpr int Dune::cpgrid::Entity< codim >::mydimension = dimension - codimension

staticconstexpr

◆ pgrid_

template<int codim>

const CpGridData* Dune::cpgrid::Entity< codim >::pgrid_

protected

Referenced by Dune::cpgrid::LevelGlobalIdSet::id(), Dune::cpgrid::GlobalIdSet::id(), Dune::cpgrid::Entity< codim >::operator==(), Dune::cpgrid::LevelGlobalIdSet::subId(), and Dune::cpgrid::GlobalIdSet::subId().

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

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ctype

◆ EntitySeed

◆ Geometry

◆ HierarchicIterator

◆ LeafIntersectionIterator

◆ LevelIntersectionIterator

◆ LocalGeometry

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ Entity() [1/4]

◆ Entity() [2/4]

◆ Entity() [3/4]

◆ Entity() [4/4]

Member Function Documentation

◆ father()

◆ geometry()

◆ geometryInFather()

◆ getIdxInParentCell()

◆ getLevelCartesianIdx()

◆ getLevelElem()

◆ getOrigin()

◆ hasBoundaryIntersections()

◆ hasFather()

◆ hbegin()

◆ hend()

◆ ileafbegin()

◆ ileafend()

◆ ilevelbegin()

◆ ilevelend()

◆ impl() [1/2]

◆ impl() [2/2]

◆ increment()

◆ index()

◆ isLeaf()

◆ isNew()

◆ isRegular()

◆ isValid()

◆ level()

◆ mightVanish()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator<()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ opposite()

◆ orientation()

◆ partitionType()

◆ seed()

◆ setValue()

◆ signedIndex()

◆ subEntities()

◆ subEntity() [1/2]

◆ subEntity() [2/2]

◆ type()

Friends And Related Function Documentation

◆ CpGridData

◆ GlobalIdSet

◆ HierarchicIterator

◆ LevelGlobalIdSet

Member Data Documentation

◆ codimension

◆ dimension

◆ dimensionworld

◆ mydimension

◆ pgrid_