dune-grid  2.2.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Dune::ALU3dGridEntityPointerBase< codim, GridImp > Class Template Reference

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

Inheritance diagram for Dune::ALU3dGridEntityPointerBase< codim, GridImp >:
Inheritance graph

Public Types

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

Public Member Functions

 ALU3dGridEntityPointerBase (const FactoryType &factory, const HElementType &item)
 Constructor for EntityPointer that points to an element.
 ALU3dGridEntityPointerBase (const FactoryType &factory, const HElementType &item, const int level, const int twist, const int duneFace)
 Constructor for EntityPointer that points to an element.
 ALU3dGridEntityPointerBase (const FactoryType &factory, const HBndSegType &ghostFace)
 Constructor for EntityPointer that points to an ghost.
 ALU3dGridEntityPointerBase (const FactoryType &factory, const ALU3dGridEntitySeedType &seed)
 Constructor for EntityPointer that points to an ghost.
 ALU3dGridEntityPointerBase (const ALU3dGridEntityPointerType &org)
 copy constructor
 ~ALU3dGridEntityPointerBase ()
 Destructor.
bool equals (const ALU3dGridEntityPointerType &i) const
 equality
ThisTypeoperator= (const ThisType &org)
 assignment operator
Entitydereference () const
 dereferencing
int level () const
 ask for level of entities

Protected Member Functions

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
 ALU3dGridEntityPointerBase (const FactoryType &factory, int level)
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< codim, dim, GridImp >
class ALU3dGridEntity< 0, dim, GridImp >
class ALU3dGrid< GridImp::elementType, Comm >

Detailed Description

template<int codim, class GridImp>
class Dune::ALU3dGridEntityPointerBase< codim, GridImp >

Enables iteration over all entities of a given codimension and level of a grid.

Member Typedef Documentation

template<int codim, class GridImp>
typedef ThisType Dune::ALU3dGridEntityPointerBase< codim, GridImp >::ALU3dGridEntityPointerType

typedef of my type

template<int codim, class GridImp>
typedef ALU3dGridEntitySeed<codimension, GridImp> Dune::ALU3dGridEntityPointerBase< codim, GridImp >::ALU3dGridEntitySeedType

type of entity seed

template<int codim, class GridImp>
typedef GridImp::template Codim<codimension>::Entity Dune::ALU3dGridEntityPointerBase< codim, GridImp >::Entity

type of Entity

template<int codim, class GridImp>
typedef EntityObject :: ImplementationType Dune::ALU3dGridEntityPointerBase< codim, GridImp >::EntityImp
template<int codim, class GridImp>
typedef MakeableInterfaceObject<Entity> Dune::ALU3dGridEntityPointerBase< codim, GridImp >::EntityObject

underlying EntityImplementation

template<int codim, class GridImp>
typedef ALU3dGridEntityPointer<codimension,GridImp> Dune::ALU3dGridEntityPointerBase< codim, GridImp >::EntityPointerImp

make type of entity pointer implementation available in derived classes

template<int codim, class GridImp>
typedef GridImp::GridObjectFactoryType Dune::ALU3dGridEntityPointerBase< codim, GridImp >::FactoryType

Member Enumeration Documentation

template<int codim, class GridImp>
anonymous enum
Enumerator:
codimension 

Constructor & Destructor Documentation

template<int codim, class GridImp >
Dune::ALU3dGridEntityPointerBase< codim, GridImp >::ALU3dGridEntityPointerBase ( const FactoryType factory,
const HElementType &  item 
)
inline

Constructor for EntityPointer that points to an element.

template<int codim, class GridImp >
Dune::ALU3dGridEntityPointerBase< codim, GridImp >::ALU3dGridEntityPointerBase ( const FactoryType factory,
const HElementType &  item,
const int  level,
const int  twist,
const int  duneFace 
)
inline

Constructor for EntityPointer that points to an element.

template<int codim, class GridImp >
Dune::ALU3dGridEntityPointerBase< codim, GridImp >::ALU3dGridEntityPointerBase ( const FactoryType factory,
const HBndSegType &  ghostFace 
)
inline
template<int codim, class GridImp >
Dune::ALU3dGridEntityPointerBase< codim, GridImp >::ALU3dGridEntityPointerBase ( const FactoryType factory,
const ALU3dGridEntitySeedType seed 
)
inline

Constructor for EntityPointer that points to an ghost.

template<int codim, class GridImp >
Dune::ALU3dGridEntityPointerBase< codim, GridImp >::ALU3dGridEntityPointerBase ( const ALU3dGridEntityPointerType org)
inline
template<int codim, class GridImp >
Dune::ALU3dGridEntityPointerBase< codim, GridImp >::~ALU3dGridEntityPointerBase ( )
inline

Destructor.

template<int codim, class GridImp >
Dune::ALU3dGridEntityPointerBase< codim, GridImp >::ALU3dGridEntityPointerBase ( const FactoryType factory,
int  level 
)
inlineprotected

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

References Dune::ALU3dGridEntityPointerBase< codim, GridImp >::entityImp().

Member Function Documentation

template<int codim, class GridImp >
void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::clone ( const ALU3dGridEntityPointerType org)
inlineprotected
template<int codim, class GridImp >
ALU3dGridEntityPointerBase< codim, GridImp >::Entity & Dune::ALU3dGridEntityPointerBase< codim, GridImp >::dereference ( ) const
inline
template<int codim, class GridImp >
void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::done ( )
inlineprotected

has to be called when iterator is finished

template<int codim, class GridImp>
EntityImp& Dune::ALU3dGridEntityPointerBase< codim, GridImp >::entityImp ( ) const
inlineprotected
template<int codim, class GridImp>
bool Dune::ALU3dGridEntityPointerBase< codim, GridImp >::equals ( const ALU3dGridEntityPointerType i) const
inline
template<int codim, class GridImp >
void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::freeEntity ( )
inlineprotected

put entity to entity stack

template<int codim, class GridImp >
void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::getEntity ( const ALU3dGridEntityPointerType org)
inlineprotected
template<int codim, class GridImp>
const GridImp& Dune::ALU3dGridEntityPointerBase< codim, GridImp >::grid ( ) const
inlineprotected

return reference to grid

template<int codim, class GridImp >
int Dune::ALU3dGridEntityPointerBase< codim, GridImp >::level ( ) const
inline
template<int codim, class GridImp >
ALU3dGridEntityPointerBase< codim, GridImp > & Dune::ALU3dGridEntityPointerBase< codim, GridImp >::operator= ( const ThisType org)
inline

assignment operator

Reimplemented in Dune::ALU3dGridEntityPointer< cdim, GridImp >.

template<int codim, class GridImp >
void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::updateEntityPointer ( HElementType *  item,
int  level = -1 
)
inlineprotected
template<int codim, class GridImp >
void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::updateGhostPointer ( HBndSegType &  ghostFace)
inlineprotected

Friends And Related Function Documentation

template<int codim, class GridImp>
friend class ALU3dGrid< GridImp::elementType, Comm >
friend
template<int codim, class GridImp>
friend class ALU3dGridEntity< 0, dim, GridImp >
friend
template<int codim, class GridImp>
friend class ALU3dGridEntity< codim, dim, GridImp >
friend

Member Data Documentation

template<int codim, class GridImp>
EntityObject* Dune::ALU3dGridEntityPointerBase< codim, GridImp >::entity_
mutableprotected
template<int codim, class GridImp>
const FactoryType& Dune::ALU3dGridEntityPointerBase< codim, GridImp >::factory_
protected
template<int codim, class GridImp>
bool Dune::ALU3dGridEntityPointerBase< codim, GridImp >::locked_
protected
template<int codim, class GridImp>
ALU3dGridEntitySeedType Dune::ALU3dGridEntityPointerBase< codim, GridImp >::seed_
protected

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