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

Iterator over all entities of a given codimension and level of a grid. More...

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

Inheritance diagram for Dune::IdentityGridLeafIterator< codim, pitype, GridImp >:
Inheritance graph

Public Types

enum  
 Codimension of entity pointed to. More...
 
enum  
 
typedef IdentityGridEntityPointer EntityPointerImp
 
typedef GridImp::template Codim< codim >::Entity Entity
 
typedef GridImp::HostGridType::template Codim< codim >::template Partition< pitype >::LeafIterator HostGridEntityPointer
 

Public Member Functions

 IdentityGridLeafIterator (const GridImp *identityGrid)
 
 IdentityGridLeafIterator (const GridImp *identityGrid, bool endDummy)
 Constructor which create the end iterator.
 
void increment ()
 prefix 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<int codim, PartitionIteratorType pitype, class GridImp>
class Dune::IdentityGridLeafIterator< codim, pitype, GridImp >

Iterator over all entities of a given codimension and level of a grid.

Member Typedef Documentation

◆ Entity

typedef GridImp::template Codim<codim>::Entity Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< codim >::template Partition< pitype >::LeafIterator >::Entity
inherited

◆ EntityPointerImp

typedef IdentityGridEntityPointer Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< codim >::template Partition< pitype >::LeafIterator >::EntityPointerImp
inherited

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

◆ HostGridEntityPointer

typedef GridImp::HostGridType::template Codim< codim >::template Partition< pitype >::LeafIterator Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< codim >::template Partition< pitype >::LeafIterator >::HostGridEntityPointer
inherited

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

Codimension of entity pointed to.

◆ anonymous enum

anonymous enum
inherited

Constructor & Destructor Documentation

◆ IdentityGridLeafIterator() [1/2]

template<int codim, PartitionIteratorType pitype, class GridImp >
Dune::IdentityGridLeafIterator< codim, pitype, GridImp >::IdentityGridLeafIterator ( const GridImp *  identityGrid)
inlineexplicit
Todo:
Please doc me !

◆ IdentityGridLeafIterator() [2/2]

template<int codim, PartitionIteratorType pitype, class GridImp >
Dune::IdentityGridLeafIterator< codim, pitype, GridImp >::IdentityGridLeafIterator ( const GridImp *  identityGrid,
bool  endDummy 
)
inlineexplicit

Constructor which create the end iterator.

Parameters
endDummyHere only to distinguish it from the other constructor
identityGridpointer to grid instance

Member Function Documentation

◆ compactify()

void Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< codim >::template Partition< pitype >::LeafIterator >::compactify ( )
inlineinherited

Make this pointer as small as possible.

◆ dereference()

Entity Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< codim >::template Partition< pitype >::LeafIterator >::dereference ( ) const
inlineinherited

dereferencing

◆ equals() [1/2]

bool Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< codim >::template Partition< pitype >::LeafIterator >::equals ( const IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< codim >::template Partition< pitype >::LeafIterator > &  i) const
inlineinherited

equality

◆ equals() [2/2]

bool Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< codim >::template Partition< pitype >::LeafIterator >::equals ( const IdentityGridEntityPointer< codim, GridImp, ForeignHostGridEntityPointer > &  entityPointer) const
inlineinherited

equality with EntityPointer based on different host EntityPointer

◆ increment()

template<int codim, PartitionIteratorType pitype, class GridImp >
void Dune::IdentityGridLeafIterator< codim, pitype, GridImp >::increment ( )
inline

prefix increment

◆ level()

int Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< codim >::template Partition< pitype >::LeafIterator >::level ( ) const
inlineinherited

ask for level of entity

Member Data Documentation

◆ hostEntityPointer_

HostGridEntityPointer Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< codim >::template Partition< pitype >::LeafIterator >::hostEntityPointer_
protectedinherited

◆ identityGrid_

const GridImp* Dune::IdentityGridEntityPointer< codim, GridImp, GridImp::HostGridType::template Codim< codim >::template Partition< pitype >::LeafIterator >::identityGrid_
protectedinherited

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