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

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

List of all members.

Classes
struct	Bnd
struct	Bnd< 0, Key >
Public Types
enum	{ codimension = codim }
typedef GridImp::template Codim< codimension >::Entity	Entity
	type of Entity
typedef MakeableInterfaceObject < Entity >	EntityObject
	underlying EntityImplementation
typedef EntityObject::ImplementationType	EntityImp
typedef ThisType	ALU3dGridEntitySeedType
	typedef of my type
typedef ALU3dGridEntitySeed < codimension, GridImp >	EntitySeedImp
	make type of entity pointer implementation available in derived classes
Public Member Functions
	~ALU3dGridEntitySeedBase ()
	Destructor.
	ALU3dGridEntitySeedBase ()
	Constructor for EntitySeed that points to an element.
	ALU3dGridEntitySeedBase (const HElementType &item)
	Constructor for EntitySeed that points to an element.
	ALU3dGridEntitySeedBase (const HElementType *item, const HBndSegType *ghostFace)
	Constructor for EntitySeed that points to an element.
	ALU3dGridEntitySeedBase (const HBndSegType &ghostFace)
	Constructor for EntitySeed that points to an ghost.
	ALU3dGridEntitySeedBase (const ALU3dGridEntitySeedType &org)
bool	operator== (const ALU3dGridEntitySeedType &i) const
	equality operator
bool	operator!= (const ALU3dGridEntitySeedType &i) const
	inequality operator
ThisType &	operator= (const ThisType &org)
	assignment 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)
void	set (const HElementType &item)
KeyType *	toKey (const HBndSegType *ghostFace)
void	set (const HBndSegType &ghostFace)
int	level () const
int	twist () const
int	face () const
Static Public Attributes
static const int	defaultValue = -1
static const int	defaultTwist = 0
Protected Types
enum	{ dim = GridImp::dimension }
enum	{ dimworld = GridImp::dimensionworld }
typedef ALU3dGridEntitySeedBase< codim, GridImp >	ThisType
typedef GridImp::MPICommunicatorType	Comm
typedef ALU3dImplTraits < GridImp::elementType, Comm >	ImplTraits
typedef ImplTraits::template Codim< codim > ::ImplementationType	ImplementationType
typedef ImplTraits::template Codim< codim >::InterfaceType	HElementType
typedef ImplTraits::template Codim< codim >::EntitySeedType	KeyType
typedef ImplTraits::BNDFaceType	BNDFaceType
typedef ImplTraits::HBndSegType	HBndSegType
Protected Attributes
KeyType *	item_
Friends
class	ALU3dGridEntity< codim, dim, GridImp >
class	ALU3dGridEntity< 0, dim, GridImp >
class	ALU3dGrid< GridImp::elementType, Comm >

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

---

Member Typedef Documentation

template<int codim, class GridImp>

typedef ThisType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ALU3dGridEntitySeedType

typedef of my type

Reimplemented in Dune::ALU3dGridEntitySeed< 0, GridImp >, Dune::ALU3dGridEntitySeed< cd, GridImp >, and Dune::ALU3dGridEntitySeed< codimension, GridImp >.

template<int codim, class GridImp>

typedef ImplTraits::BNDFaceType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::BNDFaceType [protected]

Reimplemented in Dune::ALU3dGridEntitySeed< 0, GridImp >.

template<int codim, class GridImp>

typedef GridImp::MPICommunicatorType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::Comm [protected]

Reimplemented in Dune::ALU3dGridEntitySeed< 0, GridImp >.

template<int codim, class GridImp>

typedef GridImp::template Codim<codimension>::Entity Dune::ALU3dGridEntitySeedBase< codim, GridImp >::Entity

type of Entity

Reimplemented in Dune::ALU3dGridEntitySeed< 0, GridImp >, Dune::ALU3dGridEntitySeed< cd, GridImp >, and Dune::ALU3dGridEntitySeed< codimension, GridImp >.

template<int codim, class GridImp>

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

template<int codim, class GridImp>

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

underlying EntityImplementation

template<int codim, class GridImp>

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

make type of entity pointer implementation available in derived classes

template<int codim, class GridImp>

typedef ImplTraits::HBndSegType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::HBndSegType [protected]

Reimplemented in Dune::ALU3dGridEntitySeed< 0, GridImp >.

template<int codim, class GridImp>

typedef ImplTraits::template Codim<codim>::InterfaceType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::HElementType [protected]

Reimplemented in Dune::ALU3dGridEntitySeed< 0, GridImp >.

template<int codim, class GridImp>

typedef ImplTraits::template Codim<codim>::ImplementationType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ImplementationType [protected]

Reimplemented in Dune::ALU3dGridEntitySeed< 0, GridImp >.

template<int codim, class GridImp>

typedef ALU3dImplTraits<GridImp::elementType, Comm > Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ImplTraits [protected]

Reimplemented in Dune::ALU3dGridEntitySeed< 0, GridImp >.

template<int codim, class GridImp>

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

template<int codim, class GridImp>

typedef ALU3dGridEntitySeedBase< codim, GridImp > Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ThisType [protected]

Reimplemented in Dune::ALU3dGridEntitySeed< 0, GridImp >.

---

Member Enumeration Documentation

template<int codim, class GridImp>

anonymous enum [protected]

Enumerator:

dim

template<int codim, class GridImp>

anonymous enum [protected]

Enumerator:

dimworld

template<int codim, class GridImp>

anonymous enum

Enumerator:

codimension

---

Constructor & Destructor Documentation

template<int codim, class GridImp>

Dune::ALU3dGridEntitySeedBase< codim, GridImp >::~ALU3dGridEntitySeedBase

(

)

[inline]

Destructor.

template<int codim, class GridImp >

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

(

)

[inline]

Constructor for EntitySeed that points to an element.

template<int codim, class GridImp >

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

(

const HElementType &

item

)

[inline]

Constructor for EntitySeed that points to an element.

template<int codim, class GridImp>

Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ALU3dGridEntitySeedBase	(	const HElementType *	item,
		const HBndSegType *	ghostFace
	)

Constructor for EntitySeed that points to an element.

template<int codim, class GridImp >

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

(

const HBndSegType &

ghostFace

)

[inline]

Constructor for EntitySeed that points to an ghost.

template<int codim, class GridImp >

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

(

const ALU3dGridEntitySeedType &

org

)

[inline]

copy constructor

---

Member Function Documentation

template<int codim, class GridImp>

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

(

)

[inline]

invalidate seed

Reimplemented in Dune::ALU3dGridEntitySeed< cd, GridImp >, and Dune::ALU3dGridEntitySeed< codimension, GridImp >.

Referenced by Dune::ALU3dGridEntitySeedBase< 0, GridImp >::~ALU3dGridEntitySeedBase().

template<int codim, class GridImp>

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

(

const ALU3dGridEntitySeedType &

i

)

const [inline]

equality

Reimplemented in Dune::ALU3dGridEntitySeed< codimension, GridImp >.

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

Referenced by Dune::ALU3dGridEntitySeedBase< 0, GridImp >::operator!=(), and Dune::ALU3dGridEntitySeedBase< 0, GridImp >::operator==().

template<int codim, class GridImp>

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

(

)

const [inline]

Reimplemented in Dune::ALU3dGridEntitySeed< cd, GridImp >, and Dune::ALU3dGridEntitySeed< codimension, GridImp >.

template<int codim, class GridImp>

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

(

)

const [inline]

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

template<int codim, class GridImp>

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

(

)

const [inline]

return iterior item

template<int codim, class GridImp>

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

(

)

const [inline]

methods for ghosts

Referenced by Dune::ALU3dGridEntityPointer< 0, GridImp >::ALU3dGridEntityPointer(), Dune::ALU3dGridEntitySeedBase< 0, GridImp >::ghost(), and Dune::ALU3dGridEntitySeedBase< 0, GridImp >::interior().

template<int codim, class GridImp>

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

(

)

const [inline]

get item from key

Referenced by Dune::ALU3dGridEntityPointerBase< codim, GridImp >::clone(), Dune::ALU3dGridEntitySeedBase< 0, GridImp >::set(), and Dune::ALU3dGridEntitySeedBase< 0, GridImp >::toKey().

template<int codim, class GridImp>

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

(

)

const [inline]

Reimplemented in Dune::ALU3dGridEntitySeed< cd, GridImp >, and Dune::ALU3dGridEntitySeed< codimension, GridImp >.

Referenced by Dune::ALU3dGridEntitySeed< codimension, GridImp >::equals().

template<int codim, class GridImp>

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

(

const ALU3dGridEntitySeedType &

i

)

const [inline]

inequality operator

Reimplemented in Dune::ALU3dGridEntitySeed< codimension, GridImp >.

template<int codim, class GridImp >

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

(

const ThisType &

org

)

[inline]

assignment operator

Reimplemented in Dune::ALU3dGridEntitySeed< codimension, GridImp >.

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

template<int codim, class GridImp>

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

(

const ALU3dGridEntitySeedType &

i

)

const [inline]

equality operator

Reimplemented in Dune::ALU3dGridEntitySeed< codimension, GridImp >.

template<int codim, class GridImp>

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

(

const HElementType &

item

)

[inline]

template<int codim, class GridImp>

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

(

const HBndSegType &

ghostFace

)

[inline]

template<int codim, class GridImp>

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

(

const HElementType *

item

)

[inline]

Referenced by Dune::ALU3dGridEntitySeedBase< 0, GridImp >::set().

template<int codim, class GridImp>

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

(

const HBndSegType *

ghostFace

)

[inline]

template<int codim, class GridImp>

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

(

)

const [inline]

Reimplemented in Dune::ALU3dGridEntitySeed< cd, GridImp >, and Dune::ALU3dGridEntitySeed< codimension, GridImp >.

---

Friends And Related Function Documentation

template<int codim, class GridImp>

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

Reimplemented in Dune::ALU3dGridEntitySeed< 0, GridImp >, Dune::ALU3dGridEntitySeed< cd, GridImp >, and Dune::ALU3dGridEntitySeed< codimension, GridImp >.

template<int codim, class GridImp>

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

Reimplemented in Dune::ALU3dGridEntitySeed< 0, GridImp >, Dune::ALU3dGridEntitySeed< cd, GridImp >, and Dune::ALU3dGridEntitySeed< codimension, GridImp >.

template<int codim, class GridImp>

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

---

Member Data Documentation

template<int codim, class GridImp>

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

Referenced by Dune::ALU3dGridEntitySeedBase< 0, GridImp >::twist().

template<int codim, class GridImp>

const int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::defaultValue = -1 [static]

Referenced by Dune::ALU3dGridEntitySeedBase< 0, GridImp >::face(), and Dune::ALU3dGridEntitySeedBase< 0, GridImp >::level().

template<int codim, class GridImp>

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

Referenced by Dune::ALU3dGridEntitySeedBase< 0, GridImp >::clear(), Dune::ALU3dGridEntitySeedBase< codim, GridImp >::equals(), Dune::ALU3dGridEntitySeedBase< 0, GridImp >::ghost(), Dune::ALU3dGridEntitySeedBase< 0, GridImp >::interior(), Dune::ALU3dGridEntitySeedBase< 0, GridImp >::isGhost(), Dune::ALU3dGridEntitySeedBase< 0, GridImp >::item(), Dune::ALU3dGridEntitySeedBase< codim, GridImp >::operator=(), and Dune::ALU3dGridEntitySeedBase< 0, GridImp >::set().

---

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

• alugrid/3d/entityseed.hh