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

#include <dune/grid/alugrid/2d/entity.hh>

Public Types

enum  { codimension = codim }
typedef
GridImp::GridObjectFactoryType 
FactoryType
typedef GridImp::template
Codim< codimension >::Entity 
Entity
 type of stored entity (interface)
typedef GridImp::template
Codim< codimension >
::EntitySeed 
EntitySeed
 type of the seed
typedef ALU2dGridEntity
< codimension, dim, GridImp > 
EntityImp
 tpye of stored entity (implementation)
typedef
MakeableInterfaceObject
< Entity
EntityObj
typedef ALU2dGridEntityPointer
< codimension, GridImp > 
EntityPointerImp

Public Member Functions

 ALU2dGridEntityPointer (const FactoryType &factory, const ElementType &item, int face=-1, int level=-1)
 Constructor for EntityPointer that points to an element.
 ALU2dGridEntityPointer (const FactoryType &factory, const EntitySeed &seed)
 Constructor for EntityPointer init of Level- and LeafIterator.
 ALU2dGridEntityPointer (const EntityImp &entity)
 Constructor for EntityPointer init of Level- and LeafIterator.
 ALU2dGridEntityPointer (const FactoryType &factory)
 Constructor for EntityPointer init of Level- and LeafIterator.
 ALU2dGridEntityPointer (const ThisType &org)
 Copy Constructor.
 ~ALU2dGridEntityPointer ()
 Destructor.
bool equals (const ThisType &i) const
 equality
Entitydereference () const
 dereferencing
int level () const
 ask for level of entities
ThisTypeoperator= (const ThisType &org)
 assigment operator
const GridImp & grid () const
 return reference top grid

Protected Member Functions

EntityImpentityImp ()
const EntityImpentityImp () const
void done ()
 has to be called when iterator is finished
void updateEntityPointer (ElementType *item, int face=-1, int level=-1)
 update underlying item pointer and set entity

Protected Attributes

const FactoryTypefactory_
 reference to entity factory
EntitySeed seed_
 the essential information
EntityObjentity_
 entity that this EntityPointer points to

Detailed Description

template<int codim, class GridImp>
class Dune::ALU2dGridEntityPointer< codim, GridImp >

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

Member Typedef Documentation

template<int codim, class GridImp>
typedef GridImp::template Codim<codimension>::Entity Dune::ALU2dGridEntityPointer< codim, GridImp >::Entity

type of stored entity (interface)

template<int codim, class GridImp>
typedef ALU2dGridEntity<codimension,dim,GridImp> Dune::ALU2dGridEntityPointer< codim, GridImp >::EntityImp

tpye of stored entity (implementation)

template<int codim, class GridImp>
typedef MakeableInterfaceObject<Entity> Dune::ALU2dGridEntityPointer< codim, GridImp >::EntityObj
template<int codim, class GridImp>
typedef ALU2dGridEntityPointer<codimension,GridImp> Dune::ALU2dGridEntityPointer< codim, GridImp >::EntityPointerImp
template<int codim, class GridImp>
typedef GridImp::template Codim<codimension>::EntitySeed Dune::ALU2dGridEntityPointer< codim, GridImp >::EntitySeed

type of the seed

template<int codim, class GridImp>
typedef GridImp :: GridObjectFactoryType Dune::ALU2dGridEntityPointer< codim, GridImp >::FactoryType

Member Enumeration Documentation

template<int codim, class GridImp>
anonymous enum
Enumerator:
codimension 

Constructor & Destructor Documentation

template<int codim, class GridImp>
Dune::ALU2dGridEntityPointer< codim, GridImp >::ALU2dGridEntityPointer ( const FactoryType factory,
const ElementType &  item,
int  face = -1,
int  level = -1 
)

Constructor for EntityPointer that points to an element.

template<int codim, class GridImp>
Dune::ALU2dGridEntityPointer< codim, GridImp >::ALU2dGridEntityPointer ( const FactoryType factory,
const EntitySeed seed 
)

Constructor for EntityPointer init of Level- and LeafIterator.

template<int codim, class GridImp>
Dune::ALU2dGridEntityPointer< codim, GridImp >::ALU2dGridEntityPointer ( const EntityImp entity)

Constructor for EntityPointer init of Level- and LeafIterator.

template<int codim, class GridImp>
Dune::ALU2dGridEntityPointer< codim, GridImp >::ALU2dGridEntityPointer ( const FactoryType factory)

Constructor for EntityPointer init of Level- and LeafIterator.

template<int codim, class GridImp>
Dune::ALU2dGridEntityPointer< codim, GridImp >::ALU2dGridEntityPointer ( const ThisType org)

Copy Constructor.

template<int codim, class GridImp>
Dune::ALU2dGridEntityPointer< codim, GridImp >::~ALU2dGridEntityPointer ( )

Destructor.

Member Function Documentation

template<int codim, class GridImp>
Entity& Dune::ALU2dGridEntityPointer< codim, GridImp >::dereference ( ) const

dereferencing

template<int codim, class GridImp>
void Dune::ALU2dGridEntityPointer< codim, GridImp >::done ( )
protected

has to be called when iterator is finished

template<int codim, class GridImp>
EntityImp& Dune::ALU2dGridEntityPointer< codim, GridImp >::entityImp ( )
protected
template<int codim, class GridImp>
const EntityImp& Dune::ALU2dGridEntityPointer< codim, GridImp >::entityImp ( ) const
protected
template<int codim, class GridImp>
bool Dune::ALU2dGridEntityPointer< codim, GridImp >::equals ( const ThisType i) const

equality

template<int codim, class GridImp>
const GridImp& Dune::ALU2dGridEntityPointer< codim, GridImp >::grid ( ) const
inline

return reference top grid

template<int codim, class GridImp>
int Dune::ALU2dGridEntityPointer< codim, GridImp >::level ( ) const

ask for level of entities

template<int codim, class GridImp>
ThisType& Dune::ALU2dGridEntityPointer< codim, GridImp >::operator= ( const ThisType org)

assigment operator

template<int codim, class GridImp>
void Dune::ALU2dGridEntityPointer< codim, GridImp >::updateEntityPointer ( ElementType *  item,
int  face = -1,
int  level = -1 
)
protected

update underlying item pointer and set entity

Member Data Documentation

template<int codim, class GridImp>
EntityObj* Dune::ALU2dGridEntityPointer< codim, GridImp >::entity_
mutableprotected

entity that this EntityPointer points to

template<int codim, class GridImp>
const FactoryType& Dune::ALU2dGridEntityPointer< codim, GridImp >::factory_
protected

reference to entity factory

Referenced by Dune::ALU2dGridEntityPointer< 0, GridImp >::grid().

template<int codim, class GridImp>
EntitySeed Dune::ALU2dGridEntityPointer< codim, GridImp >::seed_
protected

the essential information


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