dune-grid  2.2.0
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends
Dune::ALU3dGridEntityPointer< 0, GridImp > Class Template Reference

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

Inheritance diagram for Dune::ALU3dGridEntityPointer< 0, GridImp >:
Dune::ALU3dGridEntityPointerBase< 0, GridImp > Dune::ALU3dGridHierarchicIterator< GridImp >

List of all members.

Public Types

typedef
GridImp::GridObjectFactoryType 
FactoryType
typedef ALU3dGridEntitySeed
< cd, GridImp > 
ALU3dGridEntitySeedType
 type of entity seed
typedef GridImp::template
Codim< cd >::Entity 
Entity
 type of Entity
typedef ThisType ALU3dGridEntityPointerType
 typedef of my type
enum  
typedef
MakeableInterfaceObject
< Entity
EntityObject
 underlying EntityImplementation
typedef
EntityObject::ImplementationType 
EntityImp
typedef ALU3dGridEntityPointer
< codimension, GridImp > 
EntityPointerImp
 make type of entity pointer implementation available in derived classes

Public Member Functions

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

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, Comm
ImplTraits
typedef ImplTraits::template
Codim< cd >::InterfaceType 
HElementType
typedef ImplTraits::HBndSegType HBndSegType
typedef ImplTraits::BNDFaceType BNDFaceType
typedef ALU3dGridEntity
< 0, dim, GridImp > 
ALU3dGridEntityType

Protected Member Functions

 ALU3dGridEntityPointer (const FactoryType &factory, int level)
void clone (const ALU3dGridEntityPointerType &org)
void getEntity (const ALU3dGridEntityPointerType &org)
void done ()
 has to be called when iterator is finished
void freeEntity ()
 put entity to entity stack
const GridImp & grid () const
 return reference to grid
void updateGhostPointer (HBndSegType &ghostFace)
void updateEntityPointer (HElementType *item, int level=-1)
EntityImpentityImp () const

Protected Attributes

const FactoryTypefactory_
ALU3dGridEntitySeedType seed_
EntityObjectentity_
bool locked_

Friends

class ALU3dGridEntity< cd, dim, GridImp >
class ALU3dGridEntity< 0, dim, GridImp >
class ALU3dGrid< GridImp::elementType, Comm >

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

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

typedef of my type

Reimplemented from Dune::ALU3dGridEntityPointerBase< 0, GridImp >.

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

type of entity seed

Reimplemented from Dune::ALU3dGridEntityPointerBase< 0, GridImp >.

template<class GridImp >
typedef ALU3dGridEntity< 0,dim,GridImp> Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityType [protected]
template<class GridImp >
typedef ALU3dGridEntityPointerBase<0,GridImp> Dune::ALU3dGridEntityPointer< 0, GridImp >::BaseType [protected]
template<class GridImp >
typedef ImplTraits::BNDFaceType Dune::ALU3dGridEntityPointer< 0, GridImp >::BNDFaceType [protected]
template<class GridImp >
typedef GridImp::MPICommunicatorType Dune::ALU3dGridEntityPointer< 0, GridImp >::Comm [protected]
template<class GridImp >
typedef GridImp::template Codim<cd>::Entity Dune::ALU3dGridEntityPointer< 0, GridImp >::Entity
typedef EntityObject :: ImplementationType Dune::ALU3dGridEntityPointerBase< codim, GridImp >::EntityImp [inherited]

underlying EntityImplementation

make type of entity pointer implementation available in derived classes

template<class GridImp >
typedef GridImp::GridObjectFactoryType Dune::ALU3dGridEntityPointer< 0, GridImp >::FactoryType
template<class GridImp >
typedef ImplTraits::HBndSegType Dune::ALU3dGridEntityPointer< 0, GridImp >::HBndSegType [protected]
template<class GridImp >
typedef ImplTraits::template Codim<cd>::InterfaceType Dune::ALU3dGridEntityPointer< 0, GridImp >::HElementType [protected]
template<class GridImp >
typedef ALU3dImplTraits<GridImp::elementType, Comm > Dune::ALU3dGridEntityPointer< 0, GridImp >::ImplTraits [protected]
template<class GridImp >
typedef ALU3dGridEntityPointer<cd,GridImp> Dune::ALU3dGridEntityPointer< 0, GridImp >::ThisType [protected]

Member Enumeration Documentation

anonymous enum [inherited]
template<class GridImp >
anonymous enum [protected]
Enumerator:
cd 
template<class GridImp >
anonymous enum [protected]
Enumerator:
dim 
template<class GridImp >
anonymous enum [protected]
Enumerator:
dimworld 

Constructor & Destructor Documentation

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

Constructor for EntityPointer that points to an interior element.

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

Constructor for EntityPointer that points to an ghost.

template<class GridImp >
Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityPointer ( const FactoryType factory,
const ALU3dGridEntitySeedType seed 
) [inline]
template<class GridImp >
Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityPointer ( const ALU3dGridEntityType entity) [inline]
template<class GridImp >
Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityPointer ( const ALU3dGridEntityPointerType org) [inline]

copy constructor

template<class GridImp >
Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityPointer ( const FactoryType factory,
int  level 
) [inline, protected]

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


Member Function Documentation

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::clone ( const ALU3dGridEntityPointerType org) [protected, inherited]
Entity& Dune::ALU3dGridEntityPointerBase< codim, GridImp >::dereference ( ) const [inherited]

dereferencing

Reimplemented in Dune::ALU3dGridHierarchicIterator< GridImp >.

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::done ( ) [protected, inherited]

has to be called when iterator is finished

Referenced by Dune::ALU3dGridHierarchicIterator< GridImp >::ALU3dGridHierarchicIterator().

EntityImp& Dune::ALU3dGridEntityPointerBase< codim, GridImp >::entityImp ( ) const [inline, protected, inherited]
bool Dune::ALU3dGridEntityPointerBase< codim, GridImp >::equals ( const ALU3dGridEntityPointerType i) const [inherited]

equality

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::freeEntity ( ) [protected, inherited]

put entity to entity stack

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::getEntity ( const ALU3dGridEntityPointerType org) [protected, inherited]
const GridImp& Dune::ALU3dGridEntityPointerBase< codim, GridImp >::grid ( ) const [inline, protected, inherited]
int Dune::ALU3dGridEntityPointerBase< codim, GridImp >::level ( ) const [inherited]

ask for level of entities

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::updateEntityPointer ( HElementType *  item,
int  level = -1 
) [protected, inherited]
void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::updateGhostPointer ( HBndSegType &  ghostFace) [protected, inherited]

Friends And Related Function Documentation

template<class GridImp >
friend class ALU3dGrid< GridImp::elementType, Comm > [friend]
template<class GridImp >
friend class ALU3dGridEntity< 0, dim, GridImp > [friend]
template<class GridImp >
friend class ALU3dGridEntity< cd, dim, GridImp > [friend]

Member Data Documentation

EntityObject* Dune::ALU3dGridEntityPointerBase< codim, GridImp >::entity_ [mutable, protected, inherited]
const FactoryType& Dune::ALU3dGridEntityPointerBase< codim, GridImp >::factory_ [protected, inherited]
bool Dune::ALU3dGridEntityPointerBase< codim, GridImp >::locked_ [protected, inherited]
ALU3dGridEntitySeedType Dune::ALU3dGridEntityPointerBase< codim, GridImp >::seed_ [protected, inherited]

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