Dune::ALU3dGridHierarchicIterator< GridImp > Class Template Reference

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

Inheritance diagram for Dune::ALU3dGridHierarchicIterator< GridImp >:

Public Types
typedef GridImp::GridObjectFactoryType	FactoryType
typedef GridImp::template Codim< 0 >::Entity	Entity
typedef GridImp::ctype	ctype
typedef ALU3dGridEntitySeed < cd, GridImp >	ALU3dGridEntitySeedType
	type of entity seed More...
typedef ThisType	ALU3dGridEntityPointerType
	typedef of my type More...
enum
typedef MakeableInterfaceObject < Entity >	EntityObject
	underlying EntityImplementation More...
typedef EntityObject::ImplementationType	EntityImp
typedef ALU3dGridEntityPointer < codimension, GridImp >	EntityPointerImp
	make type of entity pointer implementation available in derived classes More...

Public Member Functions
	ALU3dGridHierarchicIterator (const FactoryType &factory, const HElementType &elem, int maxlevel, bool end)
	the normal Constructor More...
	ALU3dGridHierarchicIterator (const FactoryType &factory, const HBndSegType &ghost, int maxlevel, bool end)
	start constructor for ghosts More...
	ALU3dGridHierarchicIterator (const ThisType &org)
	the normal Constructor More...
void	increment ()
	increment More...
Entity &	dereference () const
	dereference Entity, faster then the entity pointersmethod More...
void	releaseEntity ()
	release entity More...
ThisType &	operator= (const ThisType &org)
	the assignment operator More...
template<class HItemType >
alu_inline HItemType *	goNextElement (const HItemType *startElem, HItemType *oldelem)
bool	equals (const ALU3dGridEntityPointerType &i) const
	equality More...
int	level () const
	ask for level of entities More...

Protected Types
enum	{ cd = 0 }
enum	{ dim = GridImp::dimension }
enum	{ dimworld = GridImp::dimensionworld }
typedef ALU3dGridEntityPointerBase < 0, GridImp >	BaseType
typedef ImplTraits::BNDFaceType	BNDFaceType
typedef ALU3dGridEntity < 0, dim, GridImp >	ALU3dGridEntityType

Protected Member Functions
void	clone (const ALU3dGridEntityPointerType &org)
void	getEntity (const ALU3dGridEntityPointerType &org)
void	done ()
	has to be called when iterator is finished More...
void	freeEntity ()
	put entity to entity stack More...
const GridImp &	grid () const
	return reference to grid More...
void	updateGhostPointer (HBndSegType &ghostFace)
void	updateEntityPointer (HElementType *item, int level=-1)
EntityImp &	entityImp () const

Protected Attributes
const FactoryType &	factory_
ALU3dGridEntitySeedType	seed_
EntityObject *	entity_

Member Typedef Documentation

template<class GridImp >

typedef ThisType Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityPointerType

inherited

typedef of my type

template<class GridImp >

typedef ALU3dGridEntitySeed<cd, GridImp> Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntitySeedType

inherited

type of entity seed

template<class GridImp >

typedef ALU3dGridEntity< 0,dim,GridImp> Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityType

protectedinherited

template<class GridImp >

typedef ALU3dGridEntityPointerBase<0,GridImp> Dune::ALU3dGridEntityPointer< 0, GridImp >::BaseType

protectedinherited

template<class GridImp >

typedef ImplTraits::BNDFaceType Dune::ALU3dGridEntityPointer< 0, GridImp >::BNDFaceType

protectedinherited

template<class GridImp>

typedef GridImp::ctype Dune::ALU3dGridHierarchicIterator< GridImp >::ctype

template<class GridImp>

typedef GridImp::template Codim<0>::Entity Dune::ALU3dGridHierarchicIterator< GridImp >::Entity

typedef EntityObject :: ImplementationType Dune::ALU3dGridEntityPointerBase< codim, GridImp >::EntityImp

inherited

typedef MakeableInterfaceObject<Entity> Dune::ALU3dGridEntityPointerBase< codim, GridImp >::EntityObject

inherited

underlying EntityImplementation

typedef ALU3dGridEntityPointer<codimension,GridImp> Dune::ALU3dGridEntityPointerBase< codim, GridImp >::EntityPointerImp

inherited

make type of entity pointer implementation available in derived classes

template<class GridImp>

typedef GridImp::GridObjectFactoryType Dune::ALU3dGridHierarchicIterator< GridImp >::FactoryType

Member Enumeration Documentation

anonymous enum

inherited

template<class GridImp >

anonymous enum

protectedinherited

Enumerator
cd

template<class GridImp >

anonymous enum

protectedinherited

Enumerator
dim

template<class GridImp >

anonymous enum

protectedinherited

Enumerator
dimworld

Constructor & Destructor Documentation

template<class GridImp >

alu_inline Dune::ALU3dGridHierarchicIterator< GridImp >::ALU3dGridHierarchicIterator	(	const FactoryType &	factory,
		const HElementType &	elem,
		int	maxlevel,
		bool	end
	)

the normal Constructor

References Dune::ALU3dGridEntityPointerBase< 0, GridImp >::done(), and Dune::ALU3dGridEntityPointerBase< 0, GridImp >::updateEntityPointer().

template<class GridImp >

alu_inline Dune::ALU3dGridHierarchicIterator< GridImp >::ALU3dGridHierarchicIterator	(	const FactoryType &	factory,
		const HBndSegType &	ghost,
		int	maxlevel,
		bool	end
	)

start constructor for ghosts

References Dune::ALU3dGridEntityPointerBase< 0, GridImp >::done(), and Dune::ALU3dGridEntityPointerBase< 0, GridImp >::updateGhostPointer().

template<class GridImp >

alu_inline Dune::ALU3dGridHierarchicIterator< GridImp >::ALU3dGridHierarchicIterator

(

const ThisType &

org

)

the normal Constructor

Member Function Documentation

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::clone ( const ALU3dGridEntityPointerType &  org )

protectedinherited

template<class GridImp >

alu_inline ALU3dGridHierarchicIterator< GridImp >::Entity & Dune::ALU3dGridHierarchicIterator< GridImp >::dereference

(

)

const

dereference Entity, faster then the entity pointersmethod

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::done ( )

protectedinherited

has to be called when iterator is finished

Referenced by Dune::ALU3dGridHierarchicIterator< GridImp >::ALU3dGridHierarchicIterator().

EntityImp& Dune::ALU3dGridEntityPointerBase< codim, GridImp >::entityImp ( ) const

inlineprotectedinherited

References Dune::ALU3dGridEntityPointerBase< codim, GridImp >::entity_.

bool Dune::ALU3dGridEntityPointerBase< codim, GridImp >::equals ( const ALU3dGridEntityPointerType &  i ) const

inherited

equality

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::freeEntity ( )

protectedinherited

put entity to entity stack

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::getEntity ( const ALU3dGridEntityPointerType &  org )

protectedinherited

template<class GridImp>

template<class HItemType >

alu_inline HItemType* Dune::ALU3dGridHierarchicIterator< GridImp >::goNextElement	(	const HItemType *	startElem,
		HItemType *	oldelem
	)

const GridImp& Dune::ALU3dGridEntityPointerBase< codim, GridImp >::grid ( ) const

inlineprotectedinherited

return reference to grid

References Dune::ALU3dGridEntityPointerBase< codim, GridImp >::factory_.

template<class GridImp >

alu_inline void Dune::ALU3dGridHierarchicIterator< GridImp >::increment

(

)

increment

int Dune::ALU3dGridEntityPointerBase< codim, GridImp >::level ( ) const

inherited

ask for level of entities

template<class GridImp >

alu_inline ALU3dGridHierarchicIterator< GridImp > & Dune::ALU3dGridHierarchicIterator< GridImp >::operator=

(

const ThisType &

org

)

the assignment operator

template<class GridImp>

void Dune::ALU3dGridHierarchicIterator< GridImp >::releaseEntity ( )

inline

release entity

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::updateEntityPointer ( HElementType *  item, int  level = -1  )

protectedinherited

Referenced by Dune::ALU3dGridHierarchicIterator< GridImp >::ALU3dGridHierarchicIterator().

void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::updateGhostPointer ( HBndSegType &  ghostFace )

protectedinherited

Referenced by Dune::ALU3dGridHierarchicIterator< GridImp >::ALU3dGridHierarchicIterator().

Member Data Documentation

EntityObject* Dune::ALU3dGridEntityPointerBase< codim, GridImp >::entity_

mutableprotectedinherited

const FactoryType& Dune::ALU3dGridEntityPointerBase< codim, GridImp >::factory_

protectedinherited

ALU3dGridEntitySeedType Dune::ALU3dGridEntityPointerBase< codim, GridImp >::seed_

protectedinherited

---

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

• alugrid/3d/entity.hh
• alugrid/3d/iterator.hh
• iterator.cc