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

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

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

Public Types

typedef GridImp::template Codim< cd >::Entity Entity
 type of Entity More...
 
typedef ThisType ALU3dGridEntitySeedType
 typedef of my type More...
 
enum  
 
typedef MakeableInterfaceObject< EntityEntityObject
 underlying EntityImplementation More...
 
typedef EntityObject::ImplementationType EntityImp
 
typedef ALU3dGridEntitySeed< codimension, GridImp > EntitySeedImp
 make type of entity pointer implementation available in derived classes More...
 

Public Member Functions

 ALU3dGridEntitySeed ()
 Constructor for EntitySeed that points to an element. More...
 
 ALU3dGridEntitySeed (const HElementType &item)
 Constructor for EntitySeed that points to an interior element. More...
 
 ALU3dGridEntitySeed (const HElementType &item, int, int, int)
 Constructor for EntitySeed that points to an interior element. More...
 
 ALU3dGridEntitySeed (const HBndSegType &ghostFace)
 Constructor for EntitySeed that points to an ghost. More...
 
 ALU3dGridEntitySeed (const ALU3dGridEntitySeedType &org)
 copy constructor More...
 
bool operator== (const ALU3dGridEntitySeedType &i) const
 equality operator More...
 
bool operator!= (const ALU3dGridEntitySeedType &i) const
 inequality operator More...
 
bool isValid () const
 check for valid seed More...
 
bool equals (const ALU3dGridEntitySeedType &i) const
 equality More...
 
void clear ()
 invalidate seed More...
 
HElementTypeitem () const
 get item from key More...
 
HElementTypeinterior () const
 return iterior item More...
 
bool isGhost () const
 methods for ghosts More...
 
BNDFaceTypeghost () const
 
KeyTypetoKey (const HElementType *item)
 
KeyTypetoKey (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, CommImplTraits
 
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

KeyTypeitem_
 

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

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
template<class GridImp >
typedef GridImp::MPICommunicatorType Dune::ALU3dGridEntitySeed< 0, GridImp >::Comm
protected
template<class GridImp >
typedef GridImp::template Codim<cd>::Entity Dune::ALU3dGridEntitySeed< 0, GridImp >::Entity

type of Entity

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
template<class GridImp >
typedef ImplTraits::template Codim<cd>::InterfaceType Dune::ALU3dGridEntitySeed< 0, GridImp >::HElementType
protected
template<class GridImp >
typedef ImplTraits::template Codim<cd>::ImplementationType Dune::ALU3dGridEntitySeed< 0, GridImp >::ImplementationType
protected
template<class GridImp >
typedef ALU3dImplTraits<GridImp::elementType, Comm > Dune::ALU3dGridEntitySeed< 0, GridImp >::ImplTraits
protected
typedef ImplTraits::template Codim<codim>::EntitySeedType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::KeyType
protectedinherited
template<class GridImp >
typedef ALU3dGridEntitySeed<cd,GridImp> Dune::ALU3dGridEntitySeed< 0, GridImp >::ThisType
protected

Member Enumeration Documentation

anonymous enum
protectedinherited
anonymous enum
protectedinherited
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 ( )
inlineinherited
bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::equals ( const ALU3dGridEntitySeedType i) const
inherited

equality

int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::face ( ) const
inlineinherited
BNDFaceType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ghost ( ) const
inlineinherited
HElementType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::interior ( ) const
inlineinherited
bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::isGhost ( ) const
inlineinherited
bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::isValid ( ) const
inlineinherited
HElementType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item ( ) const
inlineinherited
int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::level ( ) const
inlineinherited
bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::operator!= ( const ALU3dGridEntitySeedType i) const
inlineinherited
bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::operator== ( const ALU3dGridEntitySeedType i) const
inlineinherited
void Dune::ALU3dGridEntitySeedBase< codim, GridImp >::set ( const HElementType item)
inlineinherited
void Dune::ALU3dGridEntitySeedBase< codim, GridImp >::set ( const HBndSegType ghostFace)
inlineinherited
KeyType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::toKey ( const HElementType item)
inlineinherited
KeyType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::toKey ( const HBndSegType ghostFace)
inlineinherited
int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::twist ( ) const
inlineinherited

Member Data Documentation

const int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::defaultTwist
staticinherited
const int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::defaultValue
staticinherited
KeyType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item_
mutableprotectedinherited

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