dune-grid  2.2.0
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends
Dune::ALU3dGridLevelIterator< cd, pitype, GridImp > Class Template Reference

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

Inheritance diagram for Dune::ALU3dGridLevelIterator< cd, pitype, GridImp >:
Dune::ALU3dGridEntityPointer< cd, GridImp > Dune::ALU3dGridTreeIterator< ALU3DSPACE ALU3dGridLevelIteratorWrapper< cd, pitype, GridImp::MPICommunicatorType > > Dune::ALU3dGridEntityPointerBase< cd, GridImp >

List of all members.

Public Types

typedef
GridImp::GridObjectFactoryType 
FactoryType
typedef GridImp::template
Codim< cd >::Entity 
Entity
 type of Entity
typedef ALU3dGridVertexList< CommVertexListType
typedef ALU3dGridLevelIterator
< cd, pitype, GridImp > 
ThisType
 typedef of my type
typedef ALU3DSPACE
ALU3dGridLevelIteratorWrapper
< cd, pitype, Comm
IteratorType
typedef IteratorType InternalIteratorType
typedef ALU3DSPACE
IteratorElType< cd, Comm >
::val_t 
val_t
typedef ALU3dGridEntitySeed
< cd, GridImp > 
ALU3dGridEntitySeedType
 type of entity seed
typedef ALU3dGridEntityPointer
< cd, GridImp > 
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

 ALU3dGridLevelIterator (const FactoryType &factory, int level, bool)
 Constructor for begin iterator.
 ALU3dGridLevelIterator (const FactoryType &factory, int level)
 Constructor for end iterator.
 ALU3dGridLevelIterator (const ThisType &org)
 Constructor.
 ~ALU3dGridLevelIterator ()
void increment ()
 prefix increment
Entitydereference () const
 dereference Entity, faster then the entity pointersmethod
void releaseEntity ()
 release entity
ThisTypeoperator= (const ThisType &org)
 assignment of iterators
int level () const
 ask for level of entities
bool equals (const ALU3dGridEntityPointerType &i) const
 equality

Protected Types

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

Protected Member Functions

void clone (const ALU3dGridEntityPointerType &org)
void clone (const ALU3dGridEntityPointerType &org)
void updateEntityPointer (HElementType *item, int level)
void updateEntityPointer (HElementType *item, int level=-1)
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)
EntityImpentityImp () const
void firstItem (const GridImp &grid, IteratorImp &it, int level)
void setItem (const GridImp &grid, IteratorImp &it, ALU3DSPACE ALU3dGridLevelIteratorWrapper< cd, pitype, GridImp::MPICommunicatorType > &iter, int level)
void incrementIterator (const GridImp &grid, IteratorImp &it, int level)

Protected Attributes

const FactoryTypefactory_
ALU3dGridEntitySeedType seed_
EntityObjectentity_
bool locked_

Static Protected Attributes

static const int defaultValue = -665

Friends

class ALU3dGridEntity< 3, dim, GridImp >
class ALU3dGridEntity< 2, dim, GridImp >
class ALU3dGridEntity< 1, dim, GridImp >
class ALU3dGridEntity< 0, dim, GridImp >
class ALU3dGrid< GridImp::elementType, Comm >
class ALU3dGridTreeIterator< ALU3DSPACE ALU3dGridLevelIteratorWrapper< cd, pitype, Comm > >
class ALU3dGridEntity< cd, dim, GridImp >

Detailed Description

template<int cd, PartitionIteratorType pitype, class GridImp>
class Dune::ALU3dGridLevelIterator< cd, pitype, GridImp >

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


Member Typedef Documentation

template<int cd, class GridImp>
typedef ALU3dGridEntityPointer<cd,GridImp> Dune::ALU3dGridEntityPointer< cd, GridImp >::ALU3dGridEntityPointerType [inherited]

typedef of my type

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

template<int cd, class GridImp>
typedef ALU3dGridEntitySeed<cd, GridImp> Dune::ALU3dGridEntityPointer< cd, GridImp >::ALU3dGridEntitySeedType [inherited]

type of entity seed

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

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

underlying EntityImplementation

make type of entity pointer implementation available in derived classes

template<int cd, PartitionIteratorType pitype, class GridImp>
typedef GridImp::GridObjectFactoryType Dune::ALU3dGridLevelIterator< cd, pitype, GridImp >::FactoryType
template<int cd, class GridImp>
typedef ImplTraits::HBndSegType Dune::ALU3dGridEntityPointer< cd, GridImp >::HBndSegType [protected, inherited]
template<int cd, class GridImp>
typedef ImplTraits::template Codim<cd>::InterfaceType Dune::ALU3dGridEntityPointer< cd, GridImp >::HElementType [protected, inherited]
template<int cd, class GridImp>
typedef ALU3dImplTraits< GridImp::elementType, Comm > Dune::ALU3dGridEntityPointer< cd, GridImp >::ImplTraits [protected, inherited]
template<int cd, PartitionIteratorType pitype, class GridImp>
typedef IteratorType Dune::ALU3dGridLevelIterator< cd, pitype, GridImp >::InternalIteratorType
template<int cd, PartitionIteratorType pitype, class GridImp>
typedef ALU3DSPACE ALU3dGridLevelIteratorWrapper< cd, pitype, Comm > Dune::ALU3dGridLevelIterator< cd, pitype, GridImp >::IteratorType
template<int cd, PartitionIteratorType pitype, class GridImp>
typedef ALU3dGridLevelIterator<cd,pitype,GridImp> Dune::ALU3dGridLevelIterator< cd, pitype, GridImp >::ThisType

typedef of my type

Reimplemented from Dune::ALU3dGridEntityPointer< cd, GridImp >.

template<int cd, PartitionIteratorType pitype, class GridImp>
typedef ALU3DSPACE IteratorElType< cd, Comm >::val_t Dune::ALU3dGridLevelIterator< cd, pitype, GridImp >::val_t
template<int cd, PartitionIteratorType pitype, class GridImp>
typedef ALU3dGridVertexList< Comm > Dune::ALU3dGridLevelIterator< cd, pitype, GridImp >::VertexListType

Member Enumeration Documentation

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

Constructor & Destructor Documentation

template<int codim, PartitionIteratorType pitype, class GridImp >
alu_inline Dune::ALU3dGridLevelIterator< codim, pitype, GridImp >::ALU3dGridLevelIterator ( const FactoryType factory,
int  level,
bool   
)
template<int codim, PartitionIteratorType pitype, class GridImp >
alu_inline Dune::ALU3dGridLevelIterator< codim, pitype, GridImp >::ALU3dGridLevelIterator ( const FactoryType factory,
int  level 
)

Constructor for end iterator.

References Dune::ALU3dGridEntityPointerBase< cd, GridImp >::done().

template<int codim, PartitionIteratorType pitype, class GridImp >
alu_inline Dune::ALU3dGridLevelIterator< codim, pitype, GridImp >::ALU3dGridLevelIterator ( const ThisType org)

Constructor.

template<int codim, PartitionIteratorType pitype, class GridImp >
alu_inline Dune::ALU3dGridLevelIterator< codim, pitype, GridImp >::~ALU3dGridLevelIterator ( )

Member Function Documentation

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::clone ( const ALU3dGridEntityPointerType org) [protected, inherited]
template<int codim, class GridImp >
void Dune::ALU3dGridEntityPointer< codim, GridImp >::clone ( const ALU3dGridEntityPointerType org) [inline, protected, inherited]
template<int cdim, PartitionIteratorType pitype, class GridImp >
alu_inline ALU3dGridLevelIterator< cdim, pitype, GridImp >::Entity & Dune::ALU3dGridLevelIterator< cdim, pitype, GridImp >::dereference ( ) const

dereference Entity, faster then the entity pointersmethod

Reimplemented from Dune::ALU3dGridEntityPointer< cd, GridImp >.

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

equality

void Dune::ALU3dGridTreeIterator< ALU3DSPACE ALU3dGridLevelIteratorWrapper< cd, pitype, GridImp::MPICommunicatorType > >::firstItem ( const GridImp &  grid,
IteratorImp &  it,
int  level 
) [inline, protected, inherited]
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]
template<int codim, PartitionIteratorType pitype, class GridImp >
alu_inline void Dune::ALU3dGridLevelIterator< codim, pitype, GridImp >::increment ( )

prefix increment

void Dune::ALU3dGridTreeIterator< ALU3DSPACE ALU3dGridLevelIteratorWrapper< cd, pitype, GridImp::MPICommunicatorType > >::incrementIterator ( const GridImp &  grid,
IteratorImp &  it,
int  level 
) [inline, protected, inherited]
template<int codim, class GridImp >
int Dune::ALU3dGridEntityPointer< codim, GridImp >::level ( ) const [inline, inherited]

ask for level of entities

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

template<int codim, PartitionIteratorType pitype, class GridImp >
alu_inline ALU3dGridLevelIterator< codim, pitype, GridImp > & Dune::ALU3dGridLevelIterator< codim, pitype, GridImp >::operator= ( const ThisType org)

assignment of iterators

Reimplemented from Dune::ALU3dGridEntityPointer< cd, GridImp >.

template<int cd, PartitionIteratorType pitype, class GridImp>
void Dune::ALU3dGridLevelIterator< cd, pitype, GridImp >::releaseEntity ( ) [inline]

release entity

void Dune::ALU3dGridTreeIterator< ALU3DSPACE ALU3dGridLevelIteratorWrapper< cd, pitype, GridImp::MPICommunicatorType > >::setItem ( const GridImp &  grid,
IteratorImp &  it,
ALU3DSPACE ALU3dGridLevelIteratorWrapper< cd, pitype, GridImp::MPICommunicatorType > &  iter,
int  level 
) [inline, protected, inherited]
void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::updateEntityPointer ( HElementType *  item,
int  level = -1 
) [protected, inherited]
template<int codim, class GridImp >
void Dune::ALU3dGridEntityPointer< codim, GridImp >::updateEntityPointer ( HElementType item,
int  level 
) [inline, protected, inherited]
void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::updateGhostPointer ( HBndSegType &  ghostFace) [protected, inherited]

Friends And Related Function Documentation

template<int cd, PartitionIteratorType pitype, class GridImp>
friend class ALU3dGrid< GridImp::elementType, Comm > [friend]
template<int cd, PartitionIteratorType pitype, class GridImp>
friend class ALU3dGridEntity< 0, dim, GridImp > [friend]
template<int cd, PartitionIteratorType pitype, class GridImp>
friend class ALU3dGridEntity< 1, dim, GridImp > [friend]
template<int cd, PartitionIteratorType pitype, class GridImp>
friend class ALU3dGridEntity< 2, dim, GridImp > [friend]
template<int cd, PartitionIteratorType pitype, class GridImp>
friend class ALU3dGridEntity< 3, dim, GridImp > [friend]
template<int cd, class GridImp>
friend class ALU3dGridEntity< cd, dim, GridImp > [friend, inherited]
template<int cd, PartitionIteratorType pitype, class GridImp>
friend class ALU3dGridTreeIterator< ALU3DSPACE ALU3dGridLevelIteratorWrapper< cd, pitype, Comm > > [friend]

Member Data Documentation

template<int cd, class GridImp>
const int Dune::ALU3dGridEntityPointer< cd, GridImp >::defaultValue = -665 [static, protected, inherited]
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 files: