Dune::ALU2dGridEntityPointer< codim, GridImp > Class Template Reference

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

Inheritance diagram for Dune::ALU2dGridEntityPointer< codim, GridImp >:
Inheritance graph

List of all members.

Public Types

enum  { codimension = codim }
typedef
GridImp::GridObjectFactoryType 
FactoryType
typedef GridImp::template
Codim< codimension >::Entity 
Entity
 type of stored entity (interface)
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 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
void compactify ()
 release entity in order to reduce memory allocation
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
ElementType * item_
 pointer to the real (H)Element
EntityObjentity_
 entity that this EntityPointer points to
int level_
int face_

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 ALU2dGridEntity<codimension,dim,GridImp> Dune::ALU2dGridEntityPointer< codim, GridImp >::EntityImp

tpye of stored entity (implementation)

Reimplemented in Dune::ALU2dGridHierarchicIterator< GridImp >.

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

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 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>
void Dune::ALU2dGridEntityPointer< codim, GridImp >::compactify (  ) 

release entity in order to reduce memory allocation

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>
const EntityImp& Dune::ALU2dGridEntityPointer< codim, GridImp >::entityImp (  )  const [protected]
template<int codim, class GridImp>
EntityImp& Dune::ALU2dGridEntityPointer< codim, GridImp >::entityImp (  )  [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_ [mutable, protected]

entity that this EntityPointer points to

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

reference to entity factory

template<int codim, class GridImp>
ElementType* Dune::ALU2dGridEntityPointer< codim, GridImp >::item_ [mutable, protected]

pointer to the real (H)Element

template<int codim, class GridImp>
int Dune::ALU2dGridEntityPointer< codim, GridImp >::level_ [mutable, protected]

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

Generated on Fri Apr 29 2011 with Doxygen (ver 1.7.1) [doxygen-log,error-log].