Dune::MMeshEntity< codim, dim, GridImp > Class Template Reference

The implementation of entities in a MMesh. More...

#include <dune/mmesh/grid/entity.hh>

Public Types
typedef GridImp::template Codim< codim >::Geometry	Geometry
	The type of the Geometry interface class.
typedef GridImp::template Codim< codim >::EntitySeed	EntitySeed
	The type of the EntitySeed interface class.

Public Member Functions
	MMeshEntity ()
	MMeshEntity (const GridImp *mMesh, const HostGridEntity &hostEntity)
	MMeshEntity (const GridImp *mMesh, HostGridEntity &&hostEntity)
	MMeshEntity (const MMeshEntity &original)
	MMeshEntity (MMeshEntity &&original)
MMeshEntity &	operator= (const MMeshEntity &original)
MMeshEntity &	operator= (MMeshEntity &&original)
template<int cc = codim>
std::enable_if_t< cc==dim, bool >	equals (const MMeshEntity &other) const
template<int cc = codim>
std::enable_if_t< cc==1 &&dim==2, bool >	equals (const MMeshEntity &other) const
template<int cc = codim>
std::enable_if_t< cc==1 &&dim==3, bool >	equals (const MMeshEntity &other) const
template<int cc = codim>
std::enable_if_t< cc==2 &&dim==3, bool >	equals (const MMeshEntity &other) const
bool	hasFather () const
	returns true if father entity exists
EntitySeed	seed () const
	Return entity seed.
int	level () const
	level of this element
PartitionType	partitionType () const
	The partition type for parallel computing.
unsigned int	subEntities (unsigned int cc) const
	Return the number of subEntities of codimension codim.
template<int cc>
std::enable_if_t< codim==1 &&cc==dim, typename GridImp::template Codim< dim >::Entity >	subEntity (unsigned int i) const
	Obtain a cc dim subEntity of a codim 1 entity.
template<int cc>
std::enable_if_t< codim==2 &&cc==3, typename GridImp::template Codim< 3 >::Entity >	subEntity (unsigned int i) const
	Obtain a cc 3 subEntity of a codim 2 entity (only for 3d)
template<int cc>
std::enable_if_t< codim==dim &&cc==dim, typename GridImp::template Codim< dim >::Entity >	subEntity (unsigned int i) const
	Obtain a cc dim subEntity of a codim dim entity.
template<bool enable = true>
std::enable_if_t< codim==dim &&enable, MMeshIncidentIterator< GridImp > >	incidentBegin () const
	First incident element.
template<bool enable = true>
std::enable_if_t< codim==dim &&enable, MMeshIncidentIterator< GridImp > >	incidentEnd () const
	Last incident element.
template<bool enable = true>
std::enable_if_t< codim==dim - 1 &&enable, MMeshEdgeIncidentIterator< GridImp > >	incidentBegin () const
	First incident element.
template<bool enable = true>
std::enable_if_t< codim==dim - 1 &&enable, MMeshEdgeIncidentIterator< GridImp > >	incidentEnd () const
	Last incident element.
template<bool enable = true>
std::enable_if_t< codim==dim &&enable, MMeshIncidentFacetsIterator< GridImp > >	incidentFacetsBegin () const
	First incident facet.
template<bool enable = true>
std::enable_if_t< codim==dim &&enable, MMeshIncidentFacetsIterator< GridImp > >	incidentFacetsEnd () const
	Last incident facet.
template<bool enable = true>
std::enable_if_t< codim==dim &&enable, MMeshIncidentVerticesIterator< GridImp > >	incidentVerticesBegin (bool includeInfinite) const
	First incident vertex.
template<bool enable = true>
std::enable_if_t< codim==dim &&enable, MMeshIncidentVerticesIterator< GridImp > >	incidentVerticesEnd (bool includeInfinite) const
	Last incident vertex.
template<int cd = codim>
std::enable_if_t< cd==dim, std::size_t >	insertionLevel () const
	Return insertion level of vertex.
template<int cd = codim>
std::enable_if_t< cd !=dim, std::size_t >	insertionLevel () const
bool	isInterface () const
	Return if vertex is part of the interface.
int	boundaryFlag () const
Geometry	geometry () const
	geometry of this entity
GeometryType	type () const
	returns the geometry type
const HostGridEntity &	hostEntity () const
	returns the host entity
HostGridEntity &	hostEntity ()
	returns the host entity
const GridImp &	grid () const
	returns the grid
IdType	id () const
	returns id computed by vertex ids

Friends
template<class GridImp_ >
class	MMeshLeafIndexSet
template<class GridImp_ >
class	MMeshLocalIdSet
template<class GridImp_ >
class	MMeshGlobalIdSet
struct	HostGridAccess< typename std::remove_const< GridImp >::type >

Detailed Description

template<int codim, int dim, class GridImp>
class Dune::MMeshEntity< codim, dim, GridImp >

The implementation of entities in a MMesh.

Member Typedef Documentation

EntitySeed

template<int codim, int dim, class GridImp >

typedef GridImp::template Codim<codim>::EntitySeed Dune::MMeshEntity< codim, dim, GridImp >::EntitySeed

The type of the EntitySeed interface class.

Geometry

template<int codim, int dim, class GridImp >

typedef GridImp::template Codim<codim>::Geometry Dune::MMeshEntity< codim, dim, GridImp >::Geometry

The type of the Geometry interface class.

Constructor & Destructor Documentation

MMeshEntity() [1/5]

template<int codim, int dim, class GridImp >

Dune::MMeshEntity< codim, dim, GridImp >::MMeshEntity ( )

inline

MMeshEntity() [2/5]

template<int codim, int dim, class GridImp >

Dune::MMeshEntity< codim, dim, GridImp >::MMeshEntity ( const GridImp *  mMesh, const HostGridEntity &  hostEntity  )

inline

MMeshEntity() [3/5]

template<int codim, int dim, class GridImp >

Dune::MMeshEntity< codim, dim, GridImp >::MMeshEntity ( const GridImp *  mMesh, HostGridEntity &&  hostEntity  )

inline

MMeshEntity() [4/5]

template<int codim, int dim, class GridImp >

Dune::MMeshEntity< codim, dim, GridImp >::MMeshEntity ( const MMeshEntity< codim, dim, GridImp > &  original )

inline

MMeshEntity() [5/5]

template<int codim, int dim, class GridImp >

Dune::MMeshEntity< codim, dim, GridImp >::MMeshEntity ( MMeshEntity< codim, dim, GridImp > &&  original )

inline

Member Function Documentation

boundaryFlag()

template<int codim, int dim, class GridImp >

int Dune::MMeshEntity< codim, dim, GridImp >::boundaryFlag ( ) const

inline

Return boundary flag (-1 = not set, 0 = can be removed, 1 = important for domain boundary)

equals() [1/4]

template<int codim, int dim, class GridImp >

template<int cc = codim>

std::enable_if_t< cc==dim, bool > Dune::MMeshEntity< codim, dim, GridImp >::equals ( const MMeshEntity< codim, dim, GridImp > &  other ) const

inline

equals() [2/4]

template<int codim, int dim, class GridImp >

template<int cc = codim>

std::enable_if_t< cc==1 &&dim==2, bool > Dune::MMeshEntity< codim, dim, GridImp >::equals ( const MMeshEntity< codim, dim, GridImp > &  other ) const

inline

equals() [3/4]

template<int codim, int dim, class GridImp >

template<int cc = codim>

std::enable_if_t< cc==1 &&dim==3, bool > Dune::MMeshEntity< codim, dim, GridImp >::equals ( const MMeshEntity< codim, dim, GridImp > &  other ) const

inline

equals() [4/4]

template<int codim, int dim, class GridImp >

template<int cc = codim>

std::enable_if_t< cc==2 &&dim==3, bool > Dune::MMeshEntity< codim, dim, GridImp >::equals ( const MMeshEntity< codim, dim, GridImp > &  other ) const

inline

geometry()

template<int codim, int dim, class GridImp >

Geometry Dune::MMeshEntity< codim, dim, GridImp >::geometry ( ) const

inline

geometry of this entity

grid()

template<int codim, int dim, class GridImp >

const GridImp & Dune::MMeshEntity< codim, dim, GridImp >::grid ( ) const

inline

returns the grid

hasFather()

template<int codim, int dim, class GridImp >

bool Dune::MMeshEntity< codim, dim, GridImp >::hasFather ( ) const

inline

returns true if father entity exists

hostEntity() [1/2]

template<int codim, int dim, class GridImp >

HostGridEntity & Dune::MMeshEntity< codim, dim, GridImp >::hostEntity ( )

inline

returns the host entity

hostEntity() [2/2]

template<int codim, int dim, class GridImp >

const HostGridEntity & Dune::MMeshEntity< codim, dim, GridImp >::hostEntity ( ) const

inline

returns the host entity

id()

template<int codim, int dim, class GridImp >

IdType Dune::MMeshEntity< codim, dim, GridImp >::id ( ) const

inline

returns id computed by vertex ids

incidentBegin() [1/2]

template<int codim, int dim, class GridImp >

template<bool enable = true>

std::enable_if_t< codim==dim &&enable, MMeshIncidentIterator< GridImp > > Dune::MMeshEntity< codim, dim, GridImp >::incidentBegin ( ) const

inline

First incident element.

incidentBegin() [2/2]

template<int codim, int dim, class GridImp >

template<bool enable = true>

std::enable_if_t< codim==dim - 1 &&enable, MMeshEdgeIncidentIterator< GridImp > > Dune::MMeshEntity< codim, dim, GridImp >::incidentBegin ( ) const

inline

First incident element.

incidentEnd() [1/2]

template<int codim, int dim, class GridImp >

template<bool enable = true>

std::enable_if_t< codim==dim &&enable, MMeshIncidentIterator< GridImp > > Dune::MMeshEntity< codim, dim, GridImp >::incidentEnd ( ) const

inline

Last incident element.

incidentEnd() [2/2]

template<int codim, int dim, class GridImp >

template<bool enable = true>

std::enable_if_t< codim==dim - 1 &&enable, MMeshEdgeIncidentIterator< GridImp > > Dune::MMeshEntity< codim, dim, GridImp >::incidentEnd ( ) const

inline

Last incident element.

incidentFacetsBegin()

template<int codim, int dim, class GridImp >

template<bool enable = true>

std::enable_if_t< codim==dim &&enable, MMeshIncidentFacetsIterator< GridImp > > Dune::MMeshEntity< codim, dim, GridImp >::incidentFacetsBegin ( ) const

inline

First incident facet.

incidentFacetsEnd()

template<int codim, int dim, class GridImp >

template<bool enable = true>

std::enable_if_t< codim==dim &&enable, MMeshIncidentFacetsIterator< GridImp > > Dune::MMeshEntity< codim, dim, GridImp >::incidentFacetsEnd ( ) const

inline

Last incident facet.

incidentVerticesBegin()

template<int codim, int dim, class GridImp >

template<bool enable = true>

std::enable_if_t< codim==dim &&enable, MMeshIncidentVerticesIterator< GridImp > > Dune::MMeshEntity< codim, dim, GridImp >::incidentVerticesBegin ( bool  includeInfinite ) const

inline

First incident vertex.

incidentVerticesEnd()

template<int codim, int dim, class GridImp >

template<bool enable = true>

std::enable_if_t< codim==dim &&enable, MMeshIncidentVerticesIterator< GridImp > > Dune::MMeshEntity< codim, dim, GridImp >::incidentVerticesEnd ( bool  includeInfinite ) const

inline

Last incident vertex.

insertionLevel() [1/2]

template<int codim, int dim, class GridImp >

template<int cd = codim>

std::enable_if_t< cd==dim, std::size_t > Dune::MMeshEntity< codim, dim, GridImp >::insertionLevel ( ) const

inline

Return insertion level of vertex.

insertionLevel() [2/2]

template<int codim, int dim, class GridImp >

template<int cd = codim>

std::enable_if_t< cd !=dim, std::size_t > Dune::MMeshEntity< codim, dim, GridImp >::insertionLevel ( ) const

inline

Return insertion level (maximal insertionLevel of the corresponding vertices)

isInterface()

template<int codim, int dim, class GridImp >

bool Dune::MMeshEntity< codim, dim, GridImp >::isInterface ( ) const

inline

Return if vertex is part of the interface.

level()

template<int codim, int dim, class GridImp >

int Dune::MMeshEntity< codim, dim, GridImp >::level ( ) const

inline

level of this element

operator=() [1/2]

template<int codim, int dim, class GridImp >

MMeshEntity & Dune::MMeshEntity< codim, dim, GridImp >::operator= ( const MMeshEntity< codim, dim, GridImp > &  original )

inline

operator=() [2/2]

template<int codim, int dim, class GridImp >

MMeshEntity & Dune::MMeshEntity< codim, dim, GridImp >::operator= ( MMeshEntity< codim, dim, GridImp > &&  original )

inline

partitionType()

template<int codim, int dim, class GridImp >

PartitionType Dune::MMeshEntity< codim, dim, GridImp >::partitionType ( ) const

inline

The partition type for parallel computing.

seed()

template<int codim, int dim, class GridImp >

EntitySeed Dune::MMeshEntity< codim, dim, GridImp >::seed ( ) const

inline

Return entity seed.

subEntities()

template<int codim, int dim, class GridImp >

unsigned int Dune::MMeshEntity< codim, dim, GridImp >::subEntities ( unsigned int  cc ) const

inline

Return the number of subEntities of codimension codim.

subEntity() [1/3]

template<int codim, int dim, class GridImp >

template<int cc>

std::enable_if_t< codim==1 &&cc==dim, typename GridImp::template Codim< dim >::Entity > Dune::MMeshEntity< codim, dim, GridImp >::subEntity ( unsigned int  i ) const

inline

Obtain a cc dim subEntity of a codim 1 entity.

subEntity() [2/3]

template<int codim, int dim, class GridImp >

template<int cc>

std::enable_if_t< codim==2 &&cc==3, typename GridImp::template Codim< 3 >::Entity > Dune::MMeshEntity< codim, dim, GridImp >::subEntity ( unsigned int  i ) const

inline

Obtain a cc 3 subEntity of a codim 2 entity (only for 3d)

subEntity() [3/3]

template<int codim, int dim, class GridImp >

template<int cc>

std::enable_if_t< codim==dim &&cc==dim, typename GridImp::template Codim< dim >::Entity > Dune::MMeshEntity< codim, dim, GridImp >::subEntity ( unsigned int  i ) const

inline

Obtain a cc dim subEntity of a codim dim entity.

type()

template<int codim, int dim, class GridImp >

GeometryType Dune::MMeshEntity< codim, dim, GridImp >::type ( ) const

inline

returns the geometry type

Friends And Related Symbol Documentation

HostGridAccess< typename std::remove_const< GridImp >::type >

template<int codim, int dim, class GridImp >

friend struct HostGridAccess< typename std::remove_const< GridImp >::type >

friend

MMeshGlobalIdSet

template<int codim, int dim, class GridImp >

template<class GridImp_ >

friend class MMeshGlobalIdSet

friend

MMeshLeafIndexSet

template<int codim, int dim, class GridImp >

template<class GridImp_ >

friend class MMeshLeafIndexSet

friend

MMeshLocalIdSet

template<int codim, int dim, class GridImp >

template<class GridImp_ >

friend class MMeshLocalIdSet

friend

---

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

• grid/entity.hh