dune-grid  2.11
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Friends | List of all members
Dune::IdentityGridEntity< codim, dim, GridImp > Class Template Reference

The implementation of entities in a IdentityGridA 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. More...

#include <dune/grid/identitygrid/identitygridentity.hh>

Inheritance diagram for Dune::IdentityGridEntity< codim, dim, GridImp >:
Inheritance graph

Public Types

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

Public Member Functions

 IdentityGridEntity ()
 
 IdentityGridEntity (const GridImp *identityGrid, const HostGridEntity &hostEntity)
 
 IdentityGridEntity (const GridImp *identityGrid, HostGridEntity &&hostEntity)
 
 IdentityGridEntity (const IdentityGridEntity &original)
 
 IdentityGridEntity (IdentityGridEntity &&original)
 
IdentityGridEntityoperator= (const IdentityGridEntity &original)
 
IdentityGridEntityoperator= (IdentityGridEntity &&original)
 
bool equals (const IdentityGridEntity &other) const
 
bool hasFather () const
 returns true if father entity exists More...
 
EntitySeed seed () const
 Create EntitySeed. More...
 
int level () const
 level of this element More...
 
PartitionType partitionType () const
 The partition type for parallel computing. More...
 
unsigned int subEntities (unsigned int cc) const
 Return the number of subEntities of codimension codim. More...
 
Geometry geometry () const
 geometry of this entity More...
 
GeometryType type () const
 Return the name of the reference element. The type can be used to access the Dune::ReferenceElement. More...
 

Public Attributes

HostGridEntity hostEntity_
 

Static Public Attributes

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

Friends

template<class GridImp_ >
class IdentityGridLevelIndexSet
 
template<class GridImp_ >
class IdentityGridLeafIndexSet
 
template<class GridImp_ >
class IdentityGridLocalIdSet
 
template<class GridImp_ >
class IdentityGridGlobalIdSet
 
struct HostGridAccess< typename std::remove_const< GridImp >::type >
 

Detailed Description

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

The implementation of entities in a IdentityGrid

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.

Member Typedef Documentation

◆ EntitySeed

template<int codim, int dim, class GridImp>
typedef GridImp::template Codim<codim>::EntitySeed Dune::IdentityGridEntity< 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::IdentityGridEntity< codim, dim, GridImp >::Geometry

Constructor & Destructor Documentation

◆ IdentityGridEntity() [1/5]

template<int codim, int dim, class GridImp>
Dune::IdentityGridEntity< codim, dim, GridImp >::IdentityGridEntity ( )
inline

◆ IdentityGridEntity() [2/5]

template<int codim, int dim, class GridImp>
Dune::IdentityGridEntity< codim, dim, GridImp >::IdentityGridEntity ( const GridImp *  identityGrid,
const HostGridEntity &  hostEntity 
)
inline

◆ IdentityGridEntity() [3/5]

template<int codim, int dim, class GridImp>
Dune::IdentityGridEntity< codim, dim, GridImp >::IdentityGridEntity ( const GridImp *  identityGrid,
HostGridEntity &&  hostEntity 
)
inline

◆ IdentityGridEntity() [4/5]

template<int codim, int dim, class GridImp>
Dune::IdentityGridEntity< codim, dim, GridImp >::IdentityGridEntity ( const IdentityGridEntity< codim, dim, GridImp > &  original)
inline
Todo:
Please doc me !

◆ IdentityGridEntity() [5/5]

template<int codim, int dim, class GridImp>
Dune::IdentityGridEntity< codim, dim, GridImp >::IdentityGridEntity ( IdentityGridEntity< codim, dim, GridImp > &&  original)
inline

Member Function Documentation

◆ equals()

template<int codim, int dim, class GridImp>
bool Dune::IdentityGridEntity< codim, dim, GridImp >::equals ( const IdentityGridEntity< codim, dim, GridImp > &  other) const
inline

◆ geometry()

template<int codim, int dim, class GridImp>
Geometry Dune::IdentityGridEntity< codim, dim, GridImp >::geometry ( ) const
inline

geometry of this entity

◆ hasFather()

template<int codim, int dim, class GridImp>
bool Dune::IdentityGridEntity< codim, dim, GridImp >::hasFather ( ) const
inline

returns true if father entity exists

◆ level()

template<int codim, int dim, class GridImp>
int Dune::IdentityGridEntity< codim, dim, GridImp >::level ( ) const
inline

level of this element

◆ operator=() [1/2]

template<int codim, int dim, class GridImp>
IdentityGridEntity& Dune::IdentityGridEntity< codim, dim, GridImp >::operator= ( const IdentityGridEntity< codim, dim, GridImp > &  original)
inline
Todo:
Please doc me !

◆ operator=() [2/2]

template<int codim, int dim, class GridImp>
IdentityGridEntity& Dune::IdentityGridEntity< codim, dim, GridImp >::operator= ( IdentityGridEntity< codim, dim, GridImp > &&  original)
inline
Todo:
Please doc me !

◆ partitionType()

template<int codim, int dim, class GridImp>
PartitionType Dune::IdentityGridEntity< codim, dim, GridImp >::partitionType ( ) const
inline

The partition type for parallel computing.

◆ seed()

template<int codim, int dim, class GridImp>
EntitySeed Dune::IdentityGridEntity< codim, dim, GridImp >::seed ( ) const
inline

Create EntitySeed.

◆ subEntities()

template<int codim, int dim, class GridImp>
unsigned int Dune::IdentityGridEntity< codim, dim, GridImp >::subEntities ( unsigned int  cc) const
inline

Return the number of subEntities of codimension codim.

◆ type()

GeometryType Dune::EntityDefaultImplementation< cd, dim, GridImp, IdentityGridEntity >::type ( ) const
inlineinherited

Return the name of the reference element. The type can be used to access the Dune::ReferenceElement.

Friends And Related Function 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

◆ IdentityGridGlobalIdSet

template<int codim, int dim, class GridImp>
template<class GridImp_ >
friend class IdentityGridGlobalIdSet
friend

◆ IdentityGridLeafIndexSet

template<int codim, int dim, class GridImp>
template<class GridImp_ >
friend class IdentityGridLeafIndexSet
friend

◆ IdentityGridLevelIndexSet

template<int codim, int dim, class GridImp>
template<class GridImp_ >
friend class IdentityGridLevelIndexSet
friend

◆ IdentityGridLocalIdSet

template<int codim, int dim, class GridImp>
template<class GridImp_ >
friend class IdentityGridLocalIdSet
friend

Member Data Documentation

◆ codimension

constexpr int Dune::EntityDefaultImplementation< cd, dim, GridImp, IdentityGridEntity >::codimension
staticinherited

know your own codimension

◆ dimension

constexpr int Dune::EntityDefaultImplementation< cd, dim, GridImp, IdentityGridEntity >::dimension
staticinherited

Dimension of the grid.

◆ hostEntity_

template<int codim, int dim, class GridImp>
HostGridEntity Dune::IdentityGridEntity< codim, dim, GridImp >::hostEntity_

◆ mydimension

constexpr int Dune::EntityDefaultImplementation< cd, dim, GridImp, IdentityGridEntity >::mydimension
staticinherited

Know dimension of the entity.


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