dune-alugrid  2.6-git
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Dune::ALU3dGridEntityPointer< 0, GridImp > Class Template Reference

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

Inheritance diagram for Dune::ALU3dGridEntityPointer< 0, GridImp >:
Inheritance graph

Public Types

typedef ALU3dGridEntitySeed< cd, GridImp > ALU3dGridEntitySeedType
 type of entity seed More...
 
typedef GridImp::template Codim< cd >::Entity Entity
 type of Entity More...
 
typedef ThisType ALU3dGridEntityPointerType
 typedef of my type More...
 
enum  
 
typedef Entity EntityObject
 
typedef ALU3dGridEntity< codimension, dim, GridImp > EntityImp
 
typedef ALU3dGridEntityPointer< codimension, GridImp > EntityPointerImp
 make type of entity pointer implementation available in derived classes More...
 

Public Member Functions

 ALU3dGridEntityPointer (const HElementType &item)
 Constructor for EntityPointer that points to an interior element. More...
 
 ALU3dGridEntityPointer (const HBndSegType &ghostFace)
 Constructor for EntityPointer that points to an ghost. More...
 
 ALU3dGridEntityPointer (const ALU3dGridEntitySeedType &seed)
 Constructor for EntityPointer that points to given entity. More...
 
 ALU3dGridEntityPointer (const ALU3dGridEntityType &entity)
 Constructor for EntityPointer that points to an entity (interior or ghost) More...
 
 ALU3dGridEntityPointer ()
 
bool equals (const ALU3dGridEntityPointerType &i) const
 equality More...
 
Entitydereference () const
 dereferencing More...
 
int level () const
 ask for level of entities More...
 

Protected Types

enum  { cd = 0 }
 
enum  { dim = GridImp::dimension }
 
enum  { dimworld = GridImp::dimensionworld }
 
typedef ALU3dGridEntityPointerBase< 0, GridImp > BaseType
 
typedef ALU3dGridEntityPointer< cd, GridImp > ThisType
 
typedef GridImp::MPICommunicatorType Comm
 
typedef ALU3dImplTraits< GridImp::elementType, CommImplTraits
 
typedef ImplTraits::template Codim< dim, cd >::InterfaceType HElementType
 
typedef ImplTraits::HBndSegType HBndSegType
 
typedef ImplTraits::BNDFaceType BNDFaceType
 
typedef ALU3dGridEntity< 0, dim, GridImp > ALU3dGridEntityType
 

Protected Member Functions

void clone (const ALU3dGridEntityPointerType &org)
 
void done ()
 has to be called when iterator is finished More...
 
void updateGhostPointer (HBndSegType &ghostFace)
 
void updateEntityPointer (HElementType *item, int level=-1)
 
EntityImpentityImp () const
 

Protected Attributes

ALU3dGridEntitySeedType seed_
 
EntityObject entity_
 

Detailed Description

template<class GridImp>
class Dune::ALU3dGridEntityPointer< 0, GridImp >

ALUGridEntityPointer points to an entity this class is the specialisation for codim 0, it has exactly the same functionality as the ALU3dGridEntityPointerBase

Member Typedef Documentation

◆ ALU3dGridEntityPointerType

template<class GridImp >
typedef ThisType Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityPointerType

typedef of my type

◆ ALU3dGridEntitySeedType

template<class GridImp >
typedef ALU3dGridEntitySeed<cd, GridImp> Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntitySeedType

type of entity seed

◆ ALU3dGridEntityType

template<class GridImp >
typedef ALU3dGridEntity< 0,dim,GridImp> Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityType
protected

◆ BaseType

template<class GridImp >
typedef ALU3dGridEntityPointerBase<0,GridImp> Dune::ALU3dGridEntityPointer< 0, GridImp >::BaseType
protected

◆ BNDFaceType

template<class GridImp >
typedef ImplTraits::BNDFaceType Dune::ALU3dGridEntityPointer< 0, GridImp >::BNDFaceType
protected

◆ Comm

template<class GridImp >
typedef GridImp::MPICommunicatorType Dune::ALU3dGridEntityPointer< 0, GridImp >::Comm
protected

◆ Entity

template<class GridImp >
typedef GridImp::template Codim<cd>::Entity Dune::ALU3dGridEntityPointer< 0, GridImp >::Entity

type of Entity

◆ EntityImp

typedef ALU3dGridEntity<codimension,dim, GridImp> Dune::ALU3dGridEntityPointerBase< codim, GridImp >::EntityImp
inherited

◆ EntityObject

typedef Entity Dune::ALU3dGridEntityPointerBase< codim, GridImp >::EntityObject
inherited

◆ EntityPointerImp

make type of entity pointer implementation available in derived classes

◆ HBndSegType

template<class GridImp >
typedef ImplTraits::HBndSegType Dune::ALU3dGridEntityPointer< 0, GridImp >::HBndSegType
protected

◆ HElementType

template<class GridImp >
typedef ImplTraits::template Codim<dim, cd>::InterfaceType Dune::ALU3dGridEntityPointer< 0, GridImp >::HElementType
protected

◆ ImplTraits

template<class GridImp >
typedef ALU3dImplTraits< GridImp::elementType, Comm > Dune::ALU3dGridEntityPointer< 0, GridImp >::ImplTraits
protected

◆ ThisType

template<class GridImp >
typedef ALU3dGridEntityPointer<cd,GridImp> Dune::ALU3dGridEntityPointer< 0, GridImp >::ThisType
protected

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

◆ anonymous enum

template<class GridImp >
anonymous enum
protected
Enumerator
cd 

◆ anonymous enum

template<class GridImp >
anonymous enum
protected
Enumerator
dim 

◆ anonymous enum

template<class GridImp >
anonymous enum
protected
Enumerator
dimworld 

Constructor & Destructor Documentation

◆ ALU3dGridEntityPointer() [1/5]

template<class GridImp >
Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityPointer ( const HElementType item)
inline

Constructor for EntityPointer that points to an interior element.

◆ ALU3dGridEntityPointer() [2/5]

template<class GridImp >
Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityPointer ( const HBndSegType ghostFace)
inline

Constructor for EntityPointer that points to an ghost.

◆ ALU3dGridEntityPointer() [3/5]

template<class GridImp >
Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityPointer ( const ALU3dGridEntitySeedType seed)
inline

Constructor for EntityPointer that points to given entity.

◆ ALU3dGridEntityPointer() [4/5]

template<class GridImp >
Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityPointer ( const ALU3dGridEntityType entity)
inline

Constructor for EntityPointer that points to an entity (interior or ghost)

◆ ALU3dGridEntityPointer() [5/5]

template<class GridImp >
Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityPointer ( )
inline

Constructor for EntityPointer init of Level-, and Leaf-, and HierarchicIterator

Member Function Documentation

◆ clone()

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::clone ( const ALU3dGridEntityPointerType org)
inlineprotectedinherited

◆ dereference()

Entity& Dune::ALU3dGridEntityPointerBase< codim, GridImp >::dereference ( ) const
inlineinherited

dereferencing

◆ done()

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::done
inlineprotectedinherited

has to be called when iterator is finished

◆ entityImp()

EntityImp& Dune::ALU3dGridEntityPointerBase< codim, GridImp >::entityImp ( ) const
inlineprotectedinherited

◆ equals()

bool Dune::ALU3dGridEntityPointerBase< codim, GridImp >::equals ( const ALU3dGridEntityPointerType i) const
inlineinherited

equality

◆ level()

int Dune::ALU3dGridEntityPointerBase< codim, GridImp >::level ( ) const
inlineinherited

ask for level of entities

◆ updateEntityPointer()

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::updateEntityPointer ( HElementType *  item,
int  level = -1 
)
inlineprotectedinherited

◆ updateGhostPointer()

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::updateGhostPointer ( HBndSegType &  ghostFace)
inlineprotectedinherited

Member Data Documentation

◆ entity_

EntityObject Dune::ALU3dGridEntityPointerBase< codim, GridImp >::entity_
mutableprotectedinherited

◆ seed_

ALU3dGridEntitySeedType Dune::ALU3dGridEntityPointerBase< codim, GridImp >::seed_
protectedinherited

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