Dune::ALU3dGridEntitySeed< 0, GridImp > Class Template Reference

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

Inheritance diagram for Dune::ALU3dGridEntitySeed< 0, GridImp >:

List of all members.

Public Types
typedef GridImp::template Codim< cd >::Entity	Entity
	type of Entity
typedef ThisType	ALU3dGridEntitySeedType
	typedef of my type
enum
typedef MakeableInterfaceObject < Entity >	EntityObject
	underlying EntityImplementation
typedef EntityObject::ImplementationType	EntityImp
typedef ALU3dGridEntitySeed < codimension, GridImp >	EntitySeedImp
	make type of entity pointer implementation available in derived classes
Public Member Functions
	ALU3dGridEntitySeed ()
	Constructor for EntitySeed that points to an element.
	ALU3dGridEntitySeed (const HElementType &item)
	Constructor for EntitySeed that points to an interior element.
	ALU3dGridEntitySeed (const HElementType &item, int, int, int)
	Constructor for EntitySeed that points to an interior element.
	ALU3dGridEntitySeed (const HBndSegType &ghostFace)
	Constructor for EntitySeed that points to an ghost.
	ALU3dGridEntitySeed (const ALU3dGridEntitySeedType &org)
	copy constructor
bool	operator== (const ALU3dGridEntitySeedType &i) const
	equality operator
bool	operator!= (const ALU3dGridEntitySeedType &i) const
	inequality operator
bool	equals (const ALU3dGridEntitySeedType &i) const
void	clear ()
	invalidate seed
HElementType *	item () const
	get item from key
HElementType *	interior () const
	return iterior item
bool	isGhost () const
	methods for ghosts
BNDFaceType *	ghost () const
KeyType *	toKey (const HElementType *item)
KeyType *	toKey (const HBndSegType *ghostFace)
void	set (const HElementType &item)
void	set (const HBndSegType &ghostFace)
int	level () const
int	twist () const
int	face () const
Static Public Attributes
static const int	defaultValue
static const int	defaultTwist
Protected Types
enum	{ cd = 0 }
enum	{ dim = GridImp::dimension }
enum	{ dimworld = GridImp::dimensionworld }
typedef ALU3dGridEntitySeedBase < 0, GridImp >	BaseType
typedef ALU3dGridEntitySeed < cd, GridImp >	ThisType
typedef GridImp::MPICommunicatorType	Comm
typedef ALU3dImplTraits < GridImp::elementType, Comm >	ImplTraits
typedef ImplTraits::template Codim< cd > ::ImplementationType	ImplementationType
typedef ImplTraits::template Codim< cd >::InterfaceType	HElementType
typedef ImplTraits::BNDFaceType	BNDFaceType
typedef ImplTraits::HBndSegType	HBndSegType
typedef ALU3dGridEntity < 0, dim, GridImp >	ALU3dGridEntityType
enum
enum
typedef ImplTraits::template Codim< codim >::EntitySeedType	KeyType
Protected Attributes
KeyType *	item_
Friends
class	ALU3dGridEntity< cd, dim, GridImp >
class	ALU3dGridEntity< 0, dim, GridImp >
class	ALU3dGrid< GridImp::elementType, Comm >
class	ALU3dGridEntity< codim, dim, GridImp >

---

Detailed Description

template<class GridImp>
class Dune::ALU3dGridEntitySeed< 0, GridImp >

ALUGridEntitySeed points to an entity this class is the specialisation for codim 0, it has exactly the same functionality as the ALU3dGridEntitySeedBase

---

Member Typedef Documentation

template<class GridImp >

typedef ThisType Dune::ALU3dGridEntitySeed< 0, GridImp >::ALU3dGridEntitySeedType

typedef of my type

Reimplemented from Dune::ALU3dGridEntitySeedBase< 0, GridImp >.

template<class GridImp >

typedef ALU3dGridEntity< 0,dim,GridImp> Dune::ALU3dGridEntitySeed< 0, GridImp >::ALU3dGridEntityType [protected]

template<class GridImp >

typedef ALU3dGridEntitySeedBase<0,GridImp> Dune::ALU3dGridEntitySeed< 0, GridImp >::BaseType [protected]

template<class GridImp >

typedef ImplTraits::BNDFaceType Dune::ALU3dGridEntitySeed< 0, GridImp >::BNDFaceType [protected]

Reimplemented from Dune::ALU3dGridEntitySeedBase< 0, GridImp >.

template<class GridImp >

typedef GridImp::MPICommunicatorType Dune::ALU3dGridEntitySeed< 0, GridImp >::Comm [protected]

Reimplemented from Dune::ALU3dGridEntitySeedBase< 0, GridImp >.

template<class GridImp >

typedef GridImp::template Codim<cd>::Entity Dune::ALU3dGridEntitySeed< 0, GridImp >::Entity

type of Entity

Reimplemented from Dune::ALU3dGridEntitySeedBase< 0, GridImp >.

typedef EntityObject :: ImplementationType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::EntityImp [inherited]

typedef MakeableInterfaceObject<Entity> Dune::ALU3dGridEntitySeedBase< codim, GridImp >::EntityObject [inherited]

underlying EntityImplementation

typedef ALU3dGridEntitySeed<codimension,GridImp> Dune::ALU3dGridEntitySeedBase< codim, GridImp >::EntitySeedImp [inherited]

make type of entity pointer implementation available in derived classes

template<class GridImp >

typedef ImplTraits::HBndSegType Dune::ALU3dGridEntitySeed< 0, GridImp >::HBndSegType [protected]

Reimplemented from Dune::ALU3dGridEntitySeedBase< 0, GridImp >.

template<class GridImp >

typedef ImplTraits::template Codim<cd>::InterfaceType Dune::ALU3dGridEntitySeed< 0, GridImp >::HElementType [protected]

Reimplemented from Dune::ALU3dGridEntitySeedBase< 0, GridImp >.

template<class GridImp >

typedef ImplTraits::template Codim<cd>::ImplementationType Dune::ALU3dGridEntitySeed< 0, GridImp >::ImplementationType [protected]

Reimplemented from Dune::ALU3dGridEntitySeedBase< 0, GridImp >.

template<class GridImp >

typedef ALU3dImplTraits<GridImp::elementType, Comm > Dune::ALU3dGridEntitySeed< 0, GridImp >::ImplTraits [protected]

Reimplemented from Dune::ALU3dGridEntitySeedBase< 0, GridImp >.

typedef ImplTraits::template Codim<codim>::EntitySeedType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::KeyType [protected, inherited]

template<class GridImp >

typedef ALU3dGridEntitySeed<cd,GridImp> Dune::ALU3dGridEntitySeed< 0, GridImp >::ThisType [protected]

Reimplemented from Dune::ALU3dGridEntitySeedBase< 0, GridImp >.

---

Member Enumeration Documentation

anonymous enum [protected, inherited]

anonymous enum [protected, inherited]

anonymous enum [inherited]

template<class GridImp >

anonymous enum [protected]

Enumerator:

cd

template<class GridImp >

anonymous enum [protected]

Enumerator:

dim

template<class GridImp >

anonymous enum [protected]

Enumerator:

dimworld

---

Constructor & Destructor Documentation

template<class GridImp >

Dune::ALU3dGridEntitySeed< 0, GridImp >::ALU3dGridEntitySeed

(

)

[inline]

Constructor for EntitySeed that points to an element.

template<class GridImp >

Dune::ALU3dGridEntitySeed< 0, GridImp >::ALU3dGridEntitySeed

(

const HElementType &

item

)

[inline]

Constructor for EntitySeed that points to an interior element.

template<class GridImp >

Dune::ALU3dGridEntitySeed< 0, GridImp >::ALU3dGridEntitySeed	(	const HElementType &	item,
		int	,
		int	,
		int
	)		[inline]

Constructor for EntitySeed that points to an interior element.

template<class GridImp >

Dune::ALU3dGridEntitySeed< 0, GridImp >::ALU3dGridEntitySeed

(

const HBndSegType &

ghostFace

)

[inline]

Constructor for EntitySeed that points to an ghost.

template<class GridImp >

Dune::ALU3dGridEntitySeed< 0, GridImp >::ALU3dGridEntitySeed

(

const ALU3dGridEntitySeedType &

org

)

[inline]

copy constructor

---

Member Function Documentation

void Dune::ALU3dGridEntitySeedBase< codim, GridImp >::clear

(

)

[inline, inherited]

invalidate seed

References Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item_.

bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::equals

(

const ALU3dGridEntitySeedType &

i

)

const [inherited]

equality

int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::face

(

)

const [inline, inherited]

References Dune::ALU3dGridEntitySeedBase< codim, GridImp >::defaultValue.

BNDFaceType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ghost

(

)

const [inline, inherited]

References Dune::ALU3dGridEntitySeedBase< codim, GridImp >::Bnd< cd, Key >::ghost(), Dune::ALU3dGridEntitySeedBase< codim, GridImp >::isGhost(), and Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item_.

HElementType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::interior

(

)

const [inline, inherited]

return iterior item

References Dune::ALU3dGridEntitySeedBase< codim, GridImp >::isGhost(), and Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item_.

bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::isGhost

(

)

const [inline, inherited]

methods for ghosts

References Dune::ALU3dGridEntitySeedBase< codim, GridImp >::Bnd< cd, Key >::isGhost(), and Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item_.

HElementType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item

(

)

const [inline, inherited]

get item from key

References Dune::ALU3dGridEntitySeedBase< codim, GridImp >::Bnd< cd, Key >::getItem(), and Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item_.

int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::level

(

)

const [inline, inherited]

References Dune::ALU3dGridEntitySeedBase< codim, GridImp >::defaultValue.

bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::operator!=

(

const ALU3dGridEntitySeedType &

i

)

const [inline, inherited]

inequality operator

References Dune::ALU3dGridEntitySeedBase< codim, GridImp >::equals().

bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::operator==

(

const ALU3dGridEntitySeedType &

i

)

const [inline, inherited]

equality operator

References Dune::ALU3dGridEntitySeedBase< codim, GridImp >::equals().

void Dune::ALU3dGridEntitySeedBase< codim, GridImp >::set

(

const HElementType &

item

)

[inline, inherited]

References Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item(), Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item_, and Dune::ALU3dGridEntitySeedBase< codim, GridImp >::toKey().

void Dune::ALU3dGridEntitySeedBase< codim, GridImp >::set

(

const HBndSegType &

ghostFace

)

[inline, inherited]

References Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item_, and Dune::ALU3dGridEntitySeedBase< codim, GridImp >::toKey().

KeyType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::toKey

(

const HElementType *

item

)

[inline, inherited]

References Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item().

KeyType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::toKey

(

const HBndSegType *

ghostFace

)

[inline, inherited]

References Dune::ALU3dGridEntitySeedBase< codim, GridImp >::Bnd< cd, Key >::toKey().

int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::twist

(

)

const [inline, inherited]

References Dune::ALU3dGridEntitySeedBase< codim, GridImp >::defaultTwist.

---

Friends And Related Function Documentation

template<class GridImp >

friend class ALU3dGrid< GridImp::elementType, Comm > [friend]

Reimplemented from Dune::ALU3dGridEntitySeedBase< 0, GridImp >.

template<class GridImp >

friend class ALU3dGridEntity< 0, dim, GridImp > [friend]

Reimplemented from Dune::ALU3dGridEntitySeedBase< 0, GridImp >.

template<class GridImp >

friend class ALU3dGridEntity< cd, dim, GridImp > [friend]

friend class ALU3dGridEntity< codim, dim, GridImp > [friend, inherited]

---

Member Data Documentation

const int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::defaultTwist [static, inherited]

const int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::defaultValue [static, inherited]

KeyType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item_ [mutable, protected, inherited]

---

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

• alugrid/3d/entityseed.hh