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

The implementation of caching entities in a MMesh interface grid. More...

#include <dune/mmesh/interface/cachingentity.hh>

Inheritance diagram for Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >:

Public Types
typedef AffineGeometry< ctype, dim, dim+1 >	Geometry
typedef Geometry::GlobalCoordinate	GlobalCoordinate
typedef GridImp::template MMeshInterfaceEntity< 0 >	MMeshInterfaceEntity
typedef GridImp::template MMeshInterfaceEntity< dim >	MMeshInterfaceVertex
typedef GridImp::template Codim< 0 >::LocalGeometry	LocalGeometry
typedef MMeshInterfaceGridLeafIntersectionIterator< GridImp >	LeafIntersectionIterator
	The Iterator over intersections on the leaf level.
typedef MMeshHierarchicIterator< GridImp >	HierarchicIterator
	Iterator over descendants of the entity.
typedef GridImp::template Codim< 0 >::EntitySeed	EntitySeed
	The type of the EntitySeed interface class.
typedef GridImp::ConnectedComponent	ConnectedComponent
	The type of the connected component.
typedef Geometry::LocalCoordinate	LocalCoordinate
using	VertexStorage = std::array< GlobalCoordinate, dim+1 >
	define the type used for storage the vertices of a caching entity

Public Member Functions
	MMeshInterfaceCachingEntity ()=delete
	MMeshInterfaceCachingEntity (const Element &element)
bool	equals (const MMeshInterfaceCachingEntity &other) const
	returns true if host entities are equal
bool	operator== (const MMeshInterfaceCachingEntity &other) const
	returns true if host entities are equal
bool	operator== (const MMeshEntity &entity) const
	returns true if caching entity has same id like mmesh entity
bool	operator< (const MMeshInterfaceCachingEntity &other) const
	returns true if id of other is greater
bool	hasFather () const
	returns true if father entity exists
const bool	isNew () const
	returns true if this entity is new after adaptation
const bool	mightVanish () const
	returns true if this entity will vanish after adaptation
int	level () const
	Level of this element.
PartitionType	partitionType () const
	The partition type for parallel computing.
Geometry	geometry () const
	Geometry of this entity.
unsigned int	subEntities (unsigned int cc) const
	Return the number of subEntities of codimension cc.
bool	isLeaf () const
	returns true if Entity has no children
ctype	intersectionVolume (const MMeshEntity &entity) const
template<int d = dim>
std::enable_if_t< d==1, bool >	equals (const MMeshInterfaceGridEntity &other) const
bool	operator== (const MMeshInterfaceGridEntity &other) const
	returns true if host entities are equal
bool	operator< (const MMeshInterfaceGridEntity &other) const
	returns true if host entities are equal
const ConnectedComponent &	connectedComponent () const
	returns the connected component
bool	hasConnectedComponent () const
	returns true if a connected component exists
auto	father () const
	returns the father entity
void	bindFather (const EntityType &father) const
LocalGeometry	geometryInFather () const
void	setIsNew (bool isNew) const
	set if this entity is new after adaptation
void	setWillVanish (bool mightVanish) const
	set if this entity will vanish after adaptation
void	mark (int refCount) const
	mark entity for refine or coarse
int	getMark () const
	get mark of entity
EntitySeed	seed () const
	Create EntitySeed.
std::size_t	subEntities (std::size_t cc) const
	Return the number of subEntities of codimension cc.
template<int cc>
std::enable_if_t< cc==0, typename GridImp::template Codim< cc >::Entity >	subEntity (std::size_t i) const
	Provide access to sub entity i of given codimension. Entities are numbered 0 ... subEntities(cc)-1.
template<int cc>
std::enable_if_t< cc==dim, typename GridImp::template Codim< cc >::Entity >	subEntity (std::size_t i) const
	Provide access to sub entity i of given codimension. Entities are numbered 0 ... subEntities(cc)-1.
template<int cc>
std::enable_if_t< cc==1 &&dim==2, typename GridImp::template Codim< cc >::Entity >	subEntity (std::size_t i) const
	Provide access to sub entity i of given codimension. Entities are numbered 0 ... subEntities(cc)-1.
MMeshInterfaceGridLeafIntersectionIterator< GridImp >	ileafbegin () const
	First leaf intersection.
MMeshInterfaceGridLeafIntersectionIterator< GridImp >	ileafend () const
	Reference to one past the last leaf intersection.
MMeshInterfaceGridLeafIntersectionIterator< GridImp >	ilevelbegin () const
	We only have one level.
MMeshInterfaceGridLeafIntersectionIterator< GridImp >	ilevelend () const
MMeshInterfaceGridHierarchicIterator< GridImp >	hbegin (int maxlevel) const
	First hierarchic entity, i.e. this entity, because we only have one level.
MMeshInterfaceGridHierarchicIterator< GridImp >	hend (int maxlevel) const
	Reference to one past the last hierarchic entity.
bool	wasRefined () const
	returns if grid was refined
bool	mightBeCoarsened () const
	returns if grid might be coarsened
GeometryType	type () const
	returns the geometry type
const MMeshInterfaceEntity &	hostEntity () const
	returns the host entity
const GridImp &	grid () const
	returns the host entity
IdType	id () const
	return cached id

Protected Attributes
VertexStorage	vertex_
	the vertices of the host entity object of this entity (for caching entity)
const EntityType *	father_

Friends
template<class GridImp_ >
class	MMeshInterfaceGridLeafIndexSet
template<class GridImp_ >
class	MMeshInterfaceGridLocalIdSet
template<class GridImp_ >
class	MMeshInterfaceGridGlobalIdSet

Detailed Description

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

The implementation of caching entities in a MMesh interface grid.

Member Typedef Documentation

ConnectedComponent

template<int dim, class GridImp >

typedef GridImp::ConnectedComponent Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::ConnectedComponent

inherited

The type of the connected component.

EntitySeed

template<int dim, class GridImp >

typedef GridImp::template Codim<0>::EntitySeed Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::EntitySeed

inherited

The type of the EntitySeed interface class.

Geometry

template<int dim, class GridImp >

typedef AffineGeometry<ctype, dim, dim + 1> Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::Geometry

GlobalCoordinate

template<int dim, class GridImp >

typedef Geometry::GlobalCoordinate Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::GlobalCoordinate

HierarchicIterator

template<int dim, class GridImp >

typedef MMeshHierarchicIterator<GridImp> Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::HierarchicIterator

inherited

Iterator over descendants of the entity.

LeafIntersectionIterator

template<int dim, class GridImp >

typedef MMeshInterfaceGridLeafIntersectionIterator<GridImp> Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::LeafIntersectionIterator

inherited

The Iterator over intersections on the leaf level.

LocalCoordinate

template<int dim, class GridImp >

typedef Geometry::LocalCoordinate Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::LocalCoordinate

inherited

LocalGeometry

template<int dim, class GridImp >

typedef GridImp::template Codim<0>::LocalGeometry Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::LocalGeometry

inherited

MMeshInterfaceEntity

template<int dim, class GridImp >

typedef GridImp::template MMeshInterfaceEntity<0> Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::MMeshInterfaceEntity

inherited

MMeshInterfaceVertex

template<int dim, class GridImp >

typedef GridImp::template MMeshInterfaceEntity<dim> Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::MMeshInterfaceVertex

inherited

VertexStorage

template<int dim, class GridImp >

using Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::VertexStorage = std::array<GlobalCoordinate, dim + 1>

inherited

define the type used for storage the vertices of a caching entity

Constructor & Destructor Documentation

MMeshInterfaceCachingEntity() [1/2]

template<int dim, class GridImp >

Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::MMeshInterfaceCachingEntity ( )

delete

MMeshInterfaceCachingEntity() [2/2]

template<int dim, class GridImp >

Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::MMeshInterfaceCachingEntity ( const Element &  element )

inlineexplicit

Member Function Documentation

bindFather()

template<int dim, class GridImp >

void Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::bindFather ( const EntityType &  father ) const

inlineinherited

connectedComponent()

template<int dim, class GridImp >

const ConnectedComponent & Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::connectedComponent ( ) const

inlineinherited

returns the connected component

equals() [1/2]

template<int dim, class GridImp >

bool Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::equals ( const MMeshInterfaceCachingEntity< 0, dim, GridImp > &  other ) const

inline

returns true if host entities are equal

equals() [2/2]

template<int dim, class GridImp >

template<int d = dim>

std::enable_if_t< d==1, bool > Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::equals ( const MMeshInterfaceGridEntity< 0, dim, GridImp > &  other ) const

inlineinherited

father()

template<int dim, class GridImp >

auto Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::father ( ) const

inlineinherited

returns the father entity

geometry()

template<int dim, class GridImp >

Geometry Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::geometry ( ) const

inline

Geometry of this entity.

geometryInFather()

template<int dim, class GridImp >

LocalGeometry Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::geometryInFather ( ) const

inlineinherited

Geometry of this entity in bounded father entity ( assumption: this \subset father )

getMark()

template<int dim, class GridImp >

int Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::getMark ( ) const

inlineinherited

get mark of entity

grid()

template<int dim, class GridImp >

const GridImp & Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::grid ( ) const

inlineinherited

returns the host entity

hasConnectedComponent()

template<int dim, class GridImp >

bool Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::hasConnectedComponent ( ) const

inlineinherited

returns true if a connected component exists

hasFather()

template<int dim, class GridImp >

bool Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::hasFather ( ) const

inline

returns true if father entity exists

hbegin()

template<int dim, class GridImp >

MMeshInterfaceGridHierarchicIterator< GridImp > Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::hbegin ( int  maxlevel ) const

inlineinherited

First hierarchic entity, i.e. this entity, because we only have one level.

hend()

template<int dim, class GridImp >

MMeshInterfaceGridHierarchicIterator< GridImp > Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::hend ( int  maxlevel ) const

inlineinherited

Reference to one past the last hierarchic entity.

hostEntity()

template<int dim, class GridImp >

const MMeshInterfaceEntity & Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::hostEntity ( ) const

inlineinherited

returns the host entity

id()

template<int dim, class GridImp >

IdType Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::id ( ) const

inlineinherited

return cached id

ileafbegin()

template<int dim, class GridImp >

MMeshInterfaceGridLeafIntersectionIterator< GridImp > Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::ileafbegin ( ) const

inlineinherited

First leaf intersection.

ileafend()

template<int dim, class GridImp >

MMeshInterfaceGridLeafIntersectionIterator< GridImp > Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::ileafend ( ) const

inlineinherited

Reference to one past the last leaf intersection.

ilevelbegin()

template<int dim, class GridImp >

MMeshInterfaceGridLeafIntersectionIterator< GridImp > Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::ilevelbegin ( ) const

inlineinherited

We only have one level.

ilevelend()

template<int dim, class GridImp >

MMeshInterfaceGridLeafIntersectionIterator< GridImp > Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::ilevelend ( ) const

inlineinherited

intersectionVolume()

template<int dim, class GridImp >

ctype Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::intersectionVolume ( const MMeshEntity &  entity ) const

inline

isLeaf()

template<int dim, class GridImp >

bool Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::isLeaf ( ) const

inline

returns true if Entity has no children

isNew()

template<int dim, class GridImp >

const bool Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::isNew ( ) const

inline

returns true if this entity is new after adaptation

level()

template<int dim, class GridImp >

int Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::level ( ) const

inline

Level of this element.

mark()

template<int dim, class GridImp >

void Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::mark ( int  refCount ) const

inlineinherited

mark entity for refine or coarse

mightBeCoarsened()

template<int dim, class GridImp >

bool Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::mightBeCoarsened ( ) const

inlineinherited

returns if grid might be coarsened

mightVanish()

template<int dim, class GridImp >

const bool Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::mightVanish ( ) const

inline

returns true if this entity will vanish after adaptation

operator<() [1/2]

template<int dim, class GridImp >

bool Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::operator< ( const MMeshInterfaceCachingEntity< 0, dim, GridImp > &  other ) const

inline

returns true if id of other is greater

operator<() [2/2]

template<int dim, class GridImp >

bool Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::operator< ( const MMeshInterfaceGridEntity< 0, dim, GridImp > &  other ) const

inlineinherited

returns true if host entities are equal

operator==() [1/3]

template<int dim, class GridImp >

bool Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::operator== ( const MMeshEntity &  entity ) const

inline

returns true if caching entity has same id like mmesh entity

operator==() [2/3]

template<int dim, class GridImp >

bool Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::operator== ( const MMeshInterfaceCachingEntity< 0, dim, GridImp > &  other ) const

inline

returns true if host entities are equal

operator==() [3/3]

template<int dim, class GridImp >

bool Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::operator== ( const MMeshInterfaceGridEntity< 0, dim, GridImp > &  other ) const

inlineinherited

returns true if host entities are equal

partitionType()

template<int dim, class GridImp >

PartitionType Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::partitionType ( ) const

inline

The partition type for parallel computing.

seed()

template<int dim, class GridImp >

EntitySeed Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::seed ( ) const

inlineinherited

Create EntitySeed.

setIsNew()

template<int dim, class GridImp >

void Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::setIsNew ( bool  isNew ) const

inlineinherited

set if this entity is new after adaptation

setWillVanish()

template<int dim, class GridImp >

void Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::setWillVanish ( bool  mightVanish ) const

inlineinherited

set if this entity will vanish after adaptation

subEntities() [1/2]

template<int dim, class GridImp >

std::size_t Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::subEntities ( std::size_t  cc ) const

inlineinherited

Return the number of subEntities of codimension cc.

subEntities() [2/2]

template<int dim, class GridImp >

unsigned int Dune::MMeshInterfaceCachingEntity< 0, dim, GridImp >::subEntities ( unsigned int  cc ) const

inline

Return the number of subEntities of codimension cc.

subEntity() [1/3]

template<int dim, class GridImp >

template<int cc>

std::enable_if_t< cc==0, typename GridImp::template Codim< cc >::Entity > Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::subEntity ( std::size_t  i ) const

inlineinherited

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

subEntity() [2/3]

template<int dim, class GridImp >

template<int cc>

std::enable_if_t< cc==dim, typename GridImp::template Codim< cc >::Entity > Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::subEntity ( std::size_t  i ) const

inlineinherited

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

subEntity() [3/3]

template<int dim, class GridImp >

template<int cc>

std::enable_if_t< cc==1 &&dim==2, typename GridImp::template Codim< cc >::Entity > Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::subEntity ( std::size_t  i ) const

inlineinherited

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

type()

template<int dim, class GridImp >

GeometryType Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::type ( ) const

inlineinherited

returns the geometry type

wasRefined()

template<int dim, class GridImp >

bool Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::wasRefined ( ) const

inlineinherited

returns if grid was refined

Friends And Related Symbol Documentation

MMeshInterfaceGridGlobalIdSet

template<int dim, class GridImp >

template<class GridImp_ >

friend class MMeshInterfaceGridGlobalIdSet

friend

MMeshInterfaceGridLeafIndexSet

template<int dim, class GridImp >

template<class GridImp_ >

friend class MMeshInterfaceGridLeafIndexSet

friend

MMeshInterfaceGridLocalIdSet

template<int dim, class GridImp >

template<class GridImp_ >

friend class MMeshInterfaceGridLocalIdSet

friend

Member Data Documentation

father_

template<int dim, class GridImp >

const EntityType* Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::father_

mutableprotectedinherited

vertex_

template<int dim, class GridImp >

VertexStorage Dune::MMeshInterfaceGridEntity< 0, dim, GridImp >::vertex_

protectedinherited

the vertices of the host entity object of this entity (for caching entity)

---

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

• interface/cachingentity.hh