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

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

Inheritance diagram for Dune::ALU3dGridLevelIterator< cd, pitype, GridImp >:
Inheritance graph

Public Types

typedef GridImp::template Codim< cd >::Entity Entity
 
typedef ALU3dGridVertexList< CommVertexListType
 
typedef ALU3dGridLevelIterator< cd, pitype, GridImp > ThisType
 typedef of my type More...
 
typedef ALU3DSPACE ALU3dGridLevelIteratorWrapper<(GridImp::dimension==2 &&cd==2) ? 3 :cd, pitype, CommIteratorType
 
typedef IteratorType InternalIteratorType
 
typedef ALU3DSPACE IteratorElType<(GridImp::dimension==2 &&cd==2) ? 3 :cd, Comm >::val_t val_t
 
typedef ALU3dGridEntitySeed< cd, GridImp > ALU3dGridEntitySeedType
 type of entity seed More...
 
typedef ALU3dGridEntityPointer< cd, GridImp > 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

 ALU3dGridLevelIterator ()
 default constructor More...
 
 ALU3dGridLevelIterator (const GridImp &grid, int level, bool)
 Constructor for begin iterator. More...
 
 ALU3dGridLevelIterator (const GridImp &grid, int level)
 Constructor for end iterator. More...
 
 ALU3dGridLevelIterator (const ThisType &org)
 Constructor. More...
 
 ~ALU3dGridLevelIterator ()
 
void increment ()
 prefix increment More...
 
void releaseEntity ()
 release entity More...
 
ThisTypeoperator= (const ThisType &org)
 assignment of iterators More...
 
bool equals (const ALU3dGridEntityPointerType &i) const
 equality More...
 
Entitydereference () const
 dereferencing More...
 
int level () const
 ask for level of entities More...
 

Protected Types

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

Protected Member Functions

void updateEntityPointer (HElementType *item, int level)
 
void updateEntityPointer (HElementType *item, int level=-1)
 
void clone (const ALU3dGridEntityPointerType &org)
 
void done ()
 has to be called when iterator is finished More...
 
void updateGhostPointer (HBndSegType &ghostFace)
 
EntityImpentityImp () const
 
void firstItem (const GridImp &grid, IteratorImp &it, int level)
 
void setItem (const GridImp &grid, IteratorImp &it, ALU3DSPACE ALU3dGridLevelIteratorWrapper<(GridImp::dimension==2 &&cd==2) ? 3 :cd, pitype, GridImp::MPICommunicatorType > &iter, int level)
 
void incrementIterator (const GridImp &grid, IteratorImp &it, int level)
 

Protected Attributes

ALU3dGridEntitySeedType seed_
 
EntityObject entity_
 

Static Protected Attributes

static const int defaultValue = -665
 

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

◆ ALU3dGridEntityPointerType

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

typedef of my type

◆ ALU3dGridEntitySeedType

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

type of entity seed

◆ ALU3dGridEntityType

template<int cd, class GridImp >
typedef ALU3dGridEntity<cd,dim,GridImp> Dune::ALU3dGridEntityPointer< cd, GridImp >::ALU3dGridEntityType
protectedinherited

◆ BNDFaceType

template<int cd, class GridImp >
typedef ImplTraits::BNDFaceType Dune::ALU3dGridEntityPointer< cd, GridImp >::BNDFaceType
protectedinherited

◆ Entity

template<int cd, PartitionIteratorType pitype, class GridImp >
typedef GridImp::template Codim<cd>::Entity Dune::ALU3dGridLevelIterator< cd, pitype, GridImp >::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<int cd, class GridImp >
typedef ImplTraits::HBndSegType Dune::ALU3dGridEntityPointer< cd, GridImp >::HBndSegType
protectedinherited

◆ HElementType

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

◆ ImplTraits

template<int cd, class GridImp >
typedef ALU3dImplTraits< GridImp::elementType, Comm > Dune::ALU3dGridEntityPointer< cd, GridImp >::ImplTraits
protectedinherited

◆ InternalIteratorType

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

◆ IteratorType

template<int cd, PartitionIteratorType pitype, class GridImp >
typedef ALU3DSPACE ALU3dGridLevelIteratorWrapper< (GridImp::dimension == 2 && cd == 2) ? 3 : cd, pitype, Comm > Dune::ALU3dGridLevelIterator< cd, pitype, GridImp >::IteratorType

◆ ThisType

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

typedef of my type

◆ val_t

template<int cd, PartitionIteratorType pitype, class GridImp >
typedef ALU3DSPACE IteratorElType< (GridImp::dimension == 2 && cd == 2) ? 3 : cd, Comm >::val_t Dune::ALU3dGridLevelIterator< cd, pitype, GridImp >::val_t

◆ VertexListType

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

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

◆ anonymous enum

template<int cd, class GridImp >
anonymous enum
protectedinherited
Enumerator
dim 

◆ anonymous enum

template<int cd, class GridImp >
anonymous enum
protectedinherited
Enumerator
dimworld 

Constructor & Destructor Documentation

◆ ALU3dGridLevelIterator() [1/4]

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

default constructor

◆ ALU3dGridLevelIterator() [2/4]

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

Constructor for begin iterator.

◆ ALU3dGridLevelIterator() [3/4]

template<int codim, PartitionIteratorType pitype, class GridImp >
alu_inline Dune::ALU3dGridLevelIterator< codim, pitype, GridImp >::ALU3dGridLevelIterator ( const GridImp &  grid,
int  level 
)

Constructor for end iterator.

◆ ALU3dGridLevelIterator() [4/4]

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

Constructor.

◆ ~ALU3dGridLevelIterator()

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

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

◆ firstItem()

void Dune::ALU3dGridTreeIterator< ALU3DSPACE ALU3dGridLevelIteratorWrapper<(GridImp::dimension==2 &&cd==2) ? 3 :cd, pitype, GridImp::MPICommunicatorType > >::firstItem ( const GridImp &  grid,
IteratorImp &  it,
int  level 
)
inlineprotectedinherited

◆ increment()

template<int codim, PartitionIteratorType pitype, class GridImp >
alu_inline void Dune::ALU3dGridLevelIterator< codim, pitype, GridImp >::increment

prefix increment

◆ incrementIterator()

void Dune::ALU3dGridTreeIterator< ALU3DSPACE ALU3dGridLevelIteratorWrapper<(GridImp::dimension==2 &&cd==2) ? 3 :cd, pitype, GridImp::MPICommunicatorType > >::incrementIterator ( const GridImp &  grid,
IteratorImp &  it,
int  level 
)
inlineprotectedinherited

◆ level()

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

ask for level of entities

◆ operator=()

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

◆ releaseEntity()

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

release entity

◆ setItem()

void Dune::ALU3dGridTreeIterator< ALU3DSPACE ALU3dGridLevelIteratorWrapper<(GridImp::dimension==2 &&cd==2) ? 3 :cd, pitype, GridImp::MPICommunicatorType > >::setItem ( const GridImp &  grid,
IteratorImp &  it,
ALU3DSPACE ALU3dGridLevelIteratorWrapper<(GridImp::dimension==2 &&cd==2) ? 3 :cd, pitype, GridImp::MPICommunicatorType > &  iter,
int  level 
)
inlineprotectedinherited

◆ updateEntityPointer() [1/2]

template<int codim, class GridImp >
void Dune::ALU3dGridEntityPointer< codim, GridImp >::updateEntityPointer ( HElementType item,
int  level 
)
inlineprotectedinherited

◆ updateEntityPointer() [2/2]

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

◆ defaultValue

template<int cd, class GridImp >
const int Dune::ALU3dGridEntityPointer< cd, GridImp >::defaultValue = -665
staticprotectedinherited

◆ 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 files: