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

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

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

Public Types

typedef GridImp::template Codim< cd >::Entity Entity
 type of Entity
 
typedef ALU3dGridEntitySeed< cd, GridImp > 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 (const ImplementationType &item)
 Constructor for EntitySeed that points to an element.
 
 ALU3dGridEntitySeed (const HElementType &item, const int level, const int twist=defaultTwist)
 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
 
bool operator== (const ALU3dGridEntitySeedType &i) const
 
bool operator!= (const ALU3dGridEntitySeedType &i) const
 
bool equals (const ALU3dGridEntitySeedType &key) const
 equality, calls BaseType equals
 
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
 
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< dim, codim >::EntitySeedType KeyType
 
typedef ImplTraits::HBndSegType HBndSegType
 

Protected Attributes

int level_
 
int twist_
 
KeyTypeitem_
 

Member Typedef Documentation

◆ ALU3dGridEntitySeedType

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

typedef of my type

◆ Entity

template<int cd, class GridImp >
typedef GridImp::template Codim<cd>::Entity Dune::ALU3dGridEntitySeed< cd, 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

typedef ImplTraits::HBndSegType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::HBndSegType
protectedinherited

◆ KeyType

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

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited

◆ anonymous enum

anonymous enum
protectedinherited

◆ anonymous enum

anonymous enum
inherited

Constructor & Destructor Documentation

◆ ALU3dGridEntitySeed() [1/5]

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

Constructor for EntitySeed that points to an element.

◆ ALU3dGridEntitySeed() [2/5]

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

Constructor for EntitySeed that points to an element.

◆ ALU3dGridEntitySeed() [3/5]

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

Constructor for EntitySeed that points to an element.

◆ ALU3dGridEntitySeed() [4/5]

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

Constructor for EntitySeed that points to given entity.

◆ ALU3dGridEntitySeed() [5/5]

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

copy constructor

Member Function Documentation

◆ clear()

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

clear the key data structure

◆ equals() [1/2]

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

equality

◆ equals() [2/2]

template<int cd, class GridImp >
bool Dune::ALU3dGridEntitySeed< cd, GridImp >::equals ( const ALU3dGridEntitySeedType key) const
inline

equality, calls BaseType equals

◆ 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()

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

return level

◆ operator!=() [1/2]

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

inequality operator

◆ operator!=() [2/2]

template<int cd, class GridImp >
bool Dune::ALU3dGridEntitySeed< cd, GridImp >::operator!= ( const ALU3dGridEntitySeedType i) const
inline

◆ operator=()

template<int codim, class GridImp >
ALU3dGridEntitySeed< codim, GridImp > & Dune::ALU3dGridEntitySeed< codim, GridImp >::operator= ( const ThisType org)
inline

assignment operator

◆ operator==() [1/2]

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

equality operator

◆ operator==() [2/2]

template<int cd, class GridImp >
bool Dune::ALU3dGridEntitySeed< cd, GridImp >::operator== ( const ALU3dGridEntitySeedType i) const
inline

◆ set() [1/3]

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

◆ set() [2/3]

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

◆ set() [3/3]

template<int cd, class GridImp >
void Dune::ALU3dGridEntitySeed< cd, GridImp >::set ( const HElementType &  item,
const int  level 
)
inline

set element and level

◆ 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()

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

return twist

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

◆ level_

template<int cd, class GridImp >
int Dune::ALU3dGridEntitySeed< cd, GridImp >::level_
protected

◆ twist_

template<int cd, class GridImp >
int Dune::ALU3dGridEntitySeed< cd, GridImp >::twist_
protected

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