dune-grid  2.3.1
Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Attributes | Friends | List of all members
Dune::ALU3dGridEntitySeed< cd, GridImp > Class Template Reference

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

Inheritance diagram for Dune::ALU3dGridEntitySeed< cd, GridImp >:
Dune::ALU3dGridEntitySeedBase< cd, GridImp >

Public Types

typedef GridImp::template
Codim< cd >::Entity 
Entity
 type of Entity
typedef ALU3dGridEntitySeed
< cd, GridImp > 
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 (const ImplementationType &item)
 Constructor for EntitySeed that points to an element.
 ALU3dGridEntitySeed (const HElementType &item, const int level, const int twist=defaultTwist, const int duneFace=defaultValue)
 Constructor for EntitySeed that points to an element.
 ALU3dGridEntitySeed ()
 Constructor for EntitySeed that points to an element.
 ALU3dGridEntitySeed (const ALU3dGridEntityType &entity)
 Constructor for EntitySeed that points to given entity.
 ALU3dGridEntitySeed (const ALU3dGridEntitySeedType &org)
 copy constructor
ThisTypeoperator= (const ThisType &org)
 assignment operator
void clear ()
 clear the key data structure
void set (const HElementType &item, const int level)
 set element and level
int level () const
 return level
int twist () const
 return twist
int face () const
 return face
bool operator== (const ALU3dGridEntitySeedType &i) const
bool operator!= (const ALU3dGridEntitySeedType &i) const
bool equals (const ALU3dGridEntitySeedType &key) const
 equality, calls BaseType equals
bool operator== (const ALU3dGridEntitySeedType &i) const
 equality operator
bool operator!= (const ALU3dGridEntitySeedType &i) const
 inequality operator
bool isValid () const
 check for valid seed
bool equals (const ALU3dGridEntitySeedType &i) const
HElementType * item () const
 get item from key
HElementType * interior () const
 return iterior item
bool isGhost () const
 methods for ghosts
BNDFaceType * ghost () const
KeyTypetoKey (const HElementType *item)
KeyTypetoKey (const HBndSegType *ghostFace)
void set (const HElementType &item)
void set (const HBndSegType &ghostFace)

Static Public Attributes

static const int defaultValue
static const int defaultTwist

Protected Types

enum  
enum  
typedef ImplTraits::template
Codim< codim >::EntitySeedType 
KeyType
typedef ImplTraits::HBndSegType HBndSegType

Protected Attributes

int level_
int twist_
int face_
KeyTypeitem_

Friends

class ALU3dGridEntity< cd, dim, GridImp >
class ALU3dGridEntity< 0, dim, GridImp >
class ALU3dGrid< GridImp::elementType, Comm >

Member Typedef Documentation

template<int cd, class GridImp>
typedef ALU3dGridEntitySeed<cd,GridImp> Dune::ALU3dGridEntitySeed< cd, GridImp >::ALU3dGridEntitySeedType

typedef of my type

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

type of Entity

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

underlying EntityImplementation

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

make type of entity pointer implementation available in derived classes

typedef ImplTraits::HBndSegType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::HBndSegType
protectedinherited
typedef ImplTraits::template Codim<codim>::EntitySeedType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::KeyType
protectedinherited

Member Enumeration Documentation

anonymous enum
protectedinherited
anonymous enum
protectedinherited
anonymous enum
inherited

Constructor & Destructor Documentation

template<int cd, class GridImp>
Dune::ALU3dGridEntitySeed< cd, GridImp >::ALU3dGridEntitySeed ( const ImplementationType &  item)
inline

Constructor for EntitySeed that points to an element.

template<int codim, class GridImp >
Dune::ALU3dGridEntitySeed< codim, GridImp >::ALU3dGridEntitySeed ( const HElementType &  item,
const int  level,
const int  twist = defaultTwist,
const int  duneFace = defaultValue 
)
inline

Constructor for EntitySeed that points to an element.

template<int cd, class GridImp>
Dune::ALU3dGridEntitySeed< cd, GridImp >::ALU3dGridEntitySeed ( )
inline

Constructor for EntitySeed that points to an element.

template<int cd, class GridImp>
Dune::ALU3dGridEntitySeed< cd, GridImp >::ALU3dGridEntitySeed ( const ALU3dGridEntityType entity)
inline

Constructor for EntitySeed that points to given entity.

template<int codim, class GridImp >
Dune::ALU3dGridEntitySeed< codim, GridImp >::ALU3dGridEntitySeed ( const ALU3dGridEntitySeedType org)
inline

copy constructor

Member Function Documentation

template<int codim, class GridImp >
void Dune::ALU3dGridEntitySeed< codim, GridImp >::clear ( )
inline

clear the key data structure

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

bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::equals ( const ALU3dGridEntitySeedType i) const
inherited
template<int cd, class GridImp>
bool Dune::ALU3dGridEntitySeed< cd, GridImp >::equals ( const ALU3dGridEntitySeedType key) const
inline
template<int cd, class GridImp>
int Dune::ALU3dGridEntitySeed< cd, GridImp >::face ( ) const
inline

return face

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

Referenced by Dune::operator<<().

BNDFaceType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ghost ( ) const
inlineinherited
HElementType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::interior ( ) const
inlineinherited

return iterior item

bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::isGhost ( ) const
inlineinherited

methods for ghosts

bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::isValid ( ) const
inlineinherited

check for valid seed

HElementType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item ( ) const
inlineinherited
template<int cd, class GridImp>
int Dune::ALU3dGridEntitySeed< cd, GridImp >::level ( ) const
inline
bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::operator!= ( const ALU3dGridEntitySeedType i) const
inlineinherited

inequality operator

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

template<int cd, class GridImp>
bool Dune::ALU3dGridEntitySeed< cd, GridImp >::operator!= ( const ALU3dGridEntitySeedType i) const
inline
template<int codim, class GridImp >
ALU3dGridEntitySeed< codim, GridImp > & Dune::ALU3dGridEntitySeed< codim, GridImp >::operator= ( const ThisType org)
inline
bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::operator== ( const ALU3dGridEntitySeedType i) const
inlineinherited

equality operator

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

template<int cd, class GridImp>
bool Dune::ALU3dGridEntitySeed< cd, GridImp >::operator== ( const ALU3dGridEntitySeedType i) const
inline
void Dune::ALU3dGridEntitySeedBase< codim, GridImp >::set ( const HElementType item)
inlineinherited
void Dune::ALU3dGridEntitySeedBase< codim, GridImp >::set ( const HBndSegType ghostFace)
inlineinherited
template<int cd, class GridImp>
void Dune::ALU3dGridEntitySeed< cd, GridImp >::set ( const HElementType &  item,
const int  level 
)
inline

set element and level

KeyType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::toKey ( const HElementType item)
inlineinherited
KeyType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::toKey ( const HBndSegType ghostFace)
inlineinherited
template<int cd, class GridImp>
int Dune::ALU3dGridEntitySeed< cd, GridImp >::twist ( ) const
inline

return twist

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

Referenced by Dune::operator<<().

Friends And Related Function Documentation

template<int cd, class GridImp>
friend class ALU3dGrid< GridImp::elementType, Comm >
friend
template<int cd, class GridImp>
friend class ALU3dGridEntity< 0, dim, GridImp >
friend
template<int cd, class GridImp>
friend class ALU3dGridEntity< cd, dim, GridImp >
friend

Member Data Documentation

const int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::defaultTwist
staticinherited
const int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::defaultValue
staticinherited
template<int cd, class GridImp>
int Dune::ALU3dGridEntitySeed< cd, GridImp >::face_
protected
KeyType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item_
mutableprotectedinherited
template<int cd, class GridImp>
int Dune::ALU3dGridEntitySeed< cd, GridImp >::level_
protected
template<int cd, class GridImp>
int Dune::ALU3dGridEntitySeed< cd, GridImp >::twist_
protected

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