dune-alugrid 3.0.0
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/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
 
typedef ThisType ALU3dGridEntitySeedType
 typedef of my type
 
enum  
 
typedef GridImp::template Codim< codimension >::EntityImp EntityImp
 underlying EntityImplementation
 
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)
 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 isValid () const
 
bool operator== (const ALU3dGridEntitySeedType &i) const
 equality operator
 
bool operator!= (const ALU3dGridEntitySeedType &i) const
 inequality operator
 
bool equals (const ALU3dGridEntitySeedType &i) const
 equality
 
void clear ()
 invalidate seed
 
HElementTypeitem () const
 get item from key
 
HElementTypeinterior () const
 return iterior item
 
bool isGhost () const
 methods for ghosts
 
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
 

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< dim, cd >::ImplementationType ImplementationType
 
typedef ImplTraits::template Codim< dim, cd >::InterfaceType HElementType
 
typedef ImplTraits::BNDFaceType BNDFaceType
 
typedef ImplTraits::HBndSegType HBndSegType
 
typedef ALU3dGridEntity< 0, dim, GridImp > ALU3dGridEntityType
 
enum  
 
enum  
 
typedef ImplTraits::template Codim< dim, 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

◆ ALU3dGridEntitySeedType

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

typedef of my type

◆ ALU3dGridEntityType

template<class GridImp >
typedef ALU3dGridEntity< 0,dim,GridImp> Dune::ALU3dGridEntitySeed< 0, GridImp >::ALU3dGridEntityType
protected

◆ BaseType

template<class GridImp >
typedef ALU3dGridEntitySeedBase<0,GridImp> Dune::ALU3dGridEntitySeed< 0, GridImp >::BaseType
protected

◆ BNDFaceType

template<class GridImp >
typedef ImplTraits::BNDFaceType Dune::ALU3dGridEntitySeed< 0, GridImp >::BNDFaceType
protected

◆ Comm

template<class GridImp >
typedef GridImp::MPICommunicatorType Dune::ALU3dGridEntitySeed< 0, GridImp >::Comm
protected

◆ Entity

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

type of Entity

◆ EntityImp

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

underlying EntityImplementation

◆ EntitySeedImp

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

make type of entity pointer implementation available in derived classes

◆ HBndSegType

template<class GridImp >
typedef ImplTraits::HBndSegType Dune::ALU3dGridEntitySeed< 0, GridImp >::HBndSegType
protected

◆ HElementType

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

◆ ImplementationType

template<class GridImp >
typedef ImplTraits::template Codim<dim,cd>::ImplementationType Dune::ALU3dGridEntitySeed< 0, GridImp >::ImplementationType
protected

◆ ImplTraits

template<class GridImp >
typedef ALU3dImplTraits< GridImp::elementType, Comm > Dune::ALU3dGridEntitySeed< 0, GridImp >::ImplTraits
protected

◆ KeyType

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

◆ ThisType

template<class GridImp >
typedef ALU3dGridEntitySeed<cd,GridImp> Dune::ALU3dGridEntitySeed< 0, GridImp >::ThisType
protected

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited

◆ anonymous enum

anonymous enum
protectedinherited

◆ anonymous enum

anonymous enum
inherited

◆ anonymous enum

template<class GridImp >
anonymous enum
protected
Enumerator
cd 

◆ anonymous enum

template<class GridImp >
anonymous enum
protected
Enumerator
dim 

◆ anonymous enum

template<class GridImp >
anonymous enum
protected
Enumerator
dimworld 

Constructor & Destructor Documentation

◆ ALU3dGridEntitySeed() [1/5]

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

Constructor for EntitySeed that points to an element.

◆ ALU3dGridEntitySeed() [2/5]

template<class GridImp >
Dune::ALU3dGridEntitySeed< 0, GridImp >::ALU3dGridEntitySeed ( const HElementType item)
inline

Constructor for EntitySeed that points to an interior element.

◆ ALU3dGridEntitySeed() [3/5]

template<class GridImp >
Dune::ALU3dGridEntitySeed< 0, GridImp >::ALU3dGridEntitySeed ( const HElementType item,
int  ,
int   
)
inline

Constructor for EntitySeed that points to an interior element.

◆ ALU3dGridEntitySeed() [4/5]

template<class GridImp >
Dune::ALU3dGridEntitySeed< 0, GridImp >::ALU3dGridEntitySeed ( const HBndSegType ghostFace)
inline

Constructor for EntitySeed that points to an ghost.

◆ ALU3dGridEntitySeed() [5/5]

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

copy constructor

Member Function Documentation

◆ clear()

void Dune::ALU3dGridEntitySeedBase< codim, GridImp >::clear ( )
inlineinherited

invalidate seed

◆ equals()

bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::equals ( const ALU3dGridEntitySeedType i) const
inlineinherited

equality

◆ ghost()

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

◆ interior()

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

return iterior item

◆ isGhost()

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

methods for ghosts

◆ isValid()

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

◆ item()

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

get item from key

◆ level()

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

◆ operator!=()

bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::operator!= ( const ALU3dGridEntitySeedType i) const
inlineinherited

inequality operator

◆ operator==()

bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::operator== ( const ALU3dGridEntitySeedType i) const
inlineinherited

equality operator

◆ set() [1/2]

void Dune::ALU3dGridEntitySeedBase< codim, GridImp >::set ( const HBndSegType ghostFace)
inlineinherited

◆ set() [2/2]

void Dune::ALU3dGridEntitySeedBase< codim, GridImp >::set ( const HElementType item)
inlineinherited

◆ toKey() [1/2]

KeyType * Dune::ALU3dGridEntitySeedBase< codim, GridImp >::toKey ( const HBndSegType ghostFace)
inlineinherited

◆ toKey() [2/2]

KeyType * Dune::ALU3dGridEntitySeedBase< codim, GridImp >::toKey ( const HElementType item)
inlineinherited

◆ twist()

int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::twist ( ) const
inlineinherited

Member Data Documentation

◆ defaultTwist

const int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::defaultTwist
staticinherited

◆ defaultValue

const int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::defaultValue
staticinherited

◆ item_

KeyType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item_
mutableprotectedinherited

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