dune-grid 3.0-git
Public Types | Public Member Functions | Protected Attributes | List of all members
Dune::IdentityGridHierarchicIterator< GridImp > Class Template Reference

Iterator over the descendants of an entity.Mesh entities of codimension 0 ("elements") allow to visit all entities of codimension 0 obtained through nested, hierarchic refinement of the entity. Iteration over this set of entities is provided by the HierarchicIterator, starting from a given entity. More...

#include <dune/grid/identitygrid/identitygridhierarchiciterator.hh>

Inheritance diagram for Dune::IdentityGridHierarchicIterator< GridImp >:
Inheritance graph

Public Types

typedef Base::Entity Entity
 
enum  
 Codimension of entity pointed to. More...
 
enum  
 
typedef IdentityGridEntityPointer EntityPointerImp
 
typedef GridImp::HostGridType::template Codim< 0 >::Entity::HierarchicIterator HostGridEntityPointer
 

Public Member Functions

 IdentityGridHierarchicIterator (const GridImp *identityGrid, const Entity &startEntity, int maxLevel)
 the default Constructor
 
 IdentityGridHierarchicIterator (const GridImp *identityGrid, const Entity &startEntity, int maxLevel, bool endDummy)
 
void increment ()
 
bool equals (const IdentityGridEntityPointer &i) const
 equality
 
bool equals (const IdentityGridEntityPointer< codim, GridImp, ForeignHostGridEntityPointer > &entityPointer) const
 equality with EntityPointer based on different host EntityPointer
 
Entity dereference () const
 dereferencing
 
void compactify ()
 Make this pointer as small as possible.
 
int level () const
 ask for level of entity
 

Protected Attributes

const GridImp * identityGrid_
 
HostGridEntityPointer hostEntityPointer_
 host EntityPointer
 

Detailed Description

template<class GridImp>
class Dune::IdentityGridHierarchicIterator< GridImp >

Iterator over the descendants of an entity.

Mesh entities of codimension 0 ("elements") allow to visit all entities of codimension 0 obtained through nested, hierarchic refinement of the entity. Iteration over this set of entities is provided by the HierarchicIterator, starting from a given entity.

Member Typedef Documentation

◆ Entity

template<class GridImp >
typedef Base::Entity Dune::IdentityGridHierarchicIterator< GridImp >::Entity

◆ EntityPointerImp

typedef IdentityGridEntityPointer Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< 0 >::Entity::HierarchicIterator >::EntityPointerImp
inherited

export the type of the EntityPointer Implementation. Necessary for the typeconversion between Iterators and EntityPointer

◆ HostGridEntityPointer

typedef GridImp::HostGridType::template Codim< 0 >::Entity::HierarchicIterator Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< 0 >::Entity::HierarchicIterator >::HostGridEntityPointer
inherited

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

Codimension of entity pointed to.

◆ anonymous enum

anonymous enum
inherited

Constructor & Destructor Documentation

◆ IdentityGridHierarchicIterator() [1/2]

template<class GridImp >
Dune::IdentityGridHierarchicIterator< GridImp >::IdentityGridHierarchicIterator ( const GridImp *  identityGrid,
const Entity startEntity,
int  maxLevel 
)
inlineexplicit

the default Constructor

◆ IdentityGridHierarchicIterator() [2/2]

template<class GridImp >
Dune::IdentityGridHierarchicIterator< GridImp >::IdentityGridHierarchicIterator ( const GridImp *  identityGrid,
const Entity startEntity,
int  maxLevel,
bool  endDummy 
)
inlineexplicit
Todo:
Please doc me !

Member Function Documentation

◆ compactify()

void Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< 0 >::Entity::HierarchicIterator >::compactify ( )
inlineinherited

Make this pointer as small as possible.

◆ dereference()

Entity Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< 0 >::Entity::HierarchicIterator >::dereference ( ) const
inlineinherited

dereferencing

◆ equals() [1/2]

bool Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< 0 >::Entity::HierarchicIterator >::equals ( const IdentityGridEntityPointer< 0, GridImp, GridImp::HostGridType::template Codim< 0 >::Entity::HierarchicIterator > &  i) const
inlineinherited

equality

◆ equals() [2/2]

bool Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< 0 >::Entity::HierarchicIterator >::equals ( const IdentityGridEntityPointer< codim, GridImp, ForeignHostGridEntityPointer > &  entityPointer) const
inlineinherited

equality with EntityPointer based on different host EntityPointer

◆ increment()

template<class GridImp >
void Dune::IdentityGridHierarchicIterator< GridImp >::increment ( )
inline
Todo:
Please doc me !

◆ level()

int Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< 0 >::Entity::HierarchicIterator >::level ( ) const
inlineinherited

ask for level of entity

Member Data Documentation

◆ hostEntityPointer_

HostGridEntityPointer Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< 0 >::Entity::HierarchicIterator >::hostEntityPointer_
protectedinherited

◆ identityGrid_

const GridImp* Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< 0 >::Entity::HierarchicIterator >::identityGrid_
protectedinherited

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