Dune::LeafIterator< codim, pitype, GridImp, LeafIteratorImp > Class Template Reference
[EntityPointer and Iterators]

#include <leafiterator.hh>

Inheritance diagram for Dune::LeafIterator< codim, pitype, GridImp, LeafIteratorImp >:

Dune::EntityPointer< GridImp, LeafIteratorImp< codim, pitype, GridImp > >

List of all members.


Detailed Description

template<int codim, PartitionIteratorType pitype, class GridImp, template< int, PartitionIteratorType, class > class LeafIteratorImp>
class Dune::LeafIterator< codim, pitype, GridImp, LeafIteratorImp >

Enables iteration over all leaf entities of a codimension zero of a grid. See also the documentation of Dune::EntityPointer.

Public Types

typedef GridImp::template
Codim< 0 >::Entity 
Entity
 The Entity that this EntityPointer can point to.
enum  
 codimension of entity pointer
typedef LeafIteratorImp< codim,
pitype, GridImp > 
ImplementationType
 type of real implementation

Public Member Functions

LeafIteratoroperator++ ()
 Preincrement operator.
Implementor interface
 LeafIterator (const LeafIteratorImp< codim, pitype, const GridImp > &i)
 copy constructor from LevelIteratorImp
Constructor & conversion
 operator EntityPointer< GridImp, base > & ()
 Cast to EntityPointer with base class of implementation as engine. This conversion ensures assignablity of LevelIterator, LeafIterator and HierarchicIterator to EntityPointer.
 operator const EntityPointer< GridImp, base > & () const
 Cast to EntityPointer with const base class of implementation as engine. This conversion ensures assignablity of LevelIterator, LeafIterator and HierarchicIterator to EntityPointer.
void compactify ()
 Reduce the entity pointers used memory to a minimum necessary to store all needed information.
Dereferencing
Entityoperator* () const
 Dereferencing operator.
Entityoperator-> () const
 Pointer operator.
Compare methods
bool operator== (const EntityPointer< GridImp, base > &rhs) const
 Checks for equality. Only works for EntityPointers and iterators on the same grid. Due to the conversion operators one can compare all kinds of iterators and EntityPointer.
bool operator!= (const EntityPointer< GridImp, base > &rhs) const
 Checks for inequality. Only works for EntityPointers and iterators on the same grid. Due to the conversion operators one can compare all kinds of iterators and EntityPointer.
Query methods
int level () const
 Ask for level of entity. This method is redundant and is only there for efficiency reasons. It allows an implementation to return the level without actually constructing the entity.
Implementor interface
bool equals (const EntityPointer &rhs) const
 Forward equality check to realIterator.

Protected Types

typedef
Dune::EnableIfInterOperable
< typename LeafIteratorImp
< codim, pitype, GridImp >
::EntityPointerImp,
LeafIteratorImp< codim, pitype,
GridImp >, typename
LeafIteratorImp< codim, pitype,
GridImp >::EntityPointerImp >
::type 
base
 autocheck wether imp is convertable into imp::base

Protected Member Functions

ImplementationTypegetRealImp ()
 return reference to the real implementation
const ImplementationTypegetRealImp () const
 return reference to the real implementation

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

Generated on Thu Apr 2 10:40:47 2009 for dune-grid by  doxygen 1.5.6