dune-alugrid  2.8-git
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Attributes | List of all members
Dune::ALU3dGridEntitySeedBase< codim, GridImp > Class Template Reference

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

Inheritance diagram for Dune::ALU3dGridEntitySeedBase< codim, GridImp >:
Inheritance graph

Classes

struct  Bnd
 
struct  Bnd< 0, Key >
 

Public Types

enum  { codimension = codim }
 
typedef GridImp::template Codim< codimension >::Entity Entity
 type of Entity More...
 
typedef GridImp::template Codim< codimension >::EntityImp EntityImp
 underlying EntityImplementation More...
 
typedef ThisType ALU3dGridEntitySeedType
 typedef of my type More...
 
typedef ALU3dGridEntitySeed< codimension, GridImp > EntitySeedImp
 make type of entity pointer implementation available in derived classes More...
 

Public Member Functions

 ~ALU3dGridEntitySeedBase ()
 Destructor. More...
 
 ALU3dGridEntitySeedBase ()
 Constructor for EntitySeed that points to an element. More...
 
 ALU3dGridEntitySeedBase (const HElementType &item)
 Constructor for EntitySeed that points to an element. More...
 
 ALU3dGridEntitySeedBase (const HElementType *item, const HBndSegType *ghostFace)
 Constructor for EntitySeed that points to an element. More...
 
 ALU3dGridEntitySeedBase (const HBndSegType &ghostFace)
 Constructor for EntitySeed that points to an ghost. More...
 
 ALU3dGridEntitySeedBase (const ALU3dGridEntitySeedType &org)
 copy constructor More...
 
bool isValid () const
 
bool operator== (const ALU3dGridEntitySeedType &i) const
 equality operator More...
 
bool operator!= (const ALU3dGridEntitySeedType &i) const
 inequality operator More...
 
ThisType & operator= (const ThisType &org)
 assignment operator More...
 
bool equals (const ALU3dGridEntitySeedType &i) const
 equality More...
 
void clear ()
 invalidate seed More...
 
HElementType * item () const
 get item from key More...
 
HElementType * interior () const
 return iterior item More...
 
bool isGhost () const
 methods for ghosts More...
 
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
 

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< dim, codim >::ImplementationType ImplementationType
 
typedef ImplTraits::template Codim< dim, codim >::InterfaceType HElementType
 
typedef ImplTraits::template Codim< dim, codim >::EntitySeedType KeyType
 
typedef ImplTraits::BNDFaceType BNDFaceType
 
typedef ImplTraits::HBndSegType HBndSegType
 

Protected Attributes

KeyType * item_
 

Member Typedef Documentation

◆ ALU3dGridEntitySeedType

template<int codim, class GridImp >
typedef ThisType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ALU3dGridEntitySeedType

typedef of my type

◆ BNDFaceType

template<int codim, class GridImp >
typedef ImplTraits::BNDFaceType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::BNDFaceType
protected

◆ Comm

template<int codim, class GridImp >
typedef GridImp::MPICommunicatorType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::Comm
protected

◆ Entity

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

type of Entity

◆ EntityImp

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

underlying EntityImplementation

◆ EntitySeedImp

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

make type of entity pointer implementation available in derived classes

◆ HBndSegType

template<int codim, class GridImp >
typedef ImplTraits::HBndSegType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::HBndSegType
protected

◆ HElementType

template<int codim, class GridImp >
typedef ImplTraits::template Codim<dim, codim>::InterfaceType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::HElementType
protected

◆ ImplementationType

template<int codim, class GridImp >
typedef ImplTraits::template Codim<dim, codim>::ImplementationType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ImplementationType
protected

◆ ImplTraits

template<int codim, class GridImp >
typedef ALU3dImplTraits< GridImp::elementType, Comm > Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ImplTraits
protected

◆ KeyType

template<int codim, class GridImp >
typedef ImplTraits::template Codim<dim, codim>::EntitySeedType Dune::ALU3dGridEntitySeedBase< codim, GridImp >::KeyType
protected

◆ ThisType

template<int codim, class GridImp >
typedef ALU3dGridEntitySeedBase< codim, GridImp > Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ThisType
protected

Member Enumeration Documentation

◆ anonymous enum

template<int codim, class GridImp >
anonymous enum
protected
Enumerator
dim 

◆ anonymous enum

template<int codim, class GridImp >
anonymous enum
protected
Enumerator
dimworld 

◆ anonymous enum

template<int codim, class GridImp >
anonymous enum
Enumerator
codimension 

Constructor & Destructor Documentation

◆ ~ALU3dGridEntitySeedBase()

template<int codim, class GridImp >
Dune::ALU3dGridEntitySeedBase< codim, GridImp >::~ALU3dGridEntitySeedBase ( )
inline

Destructor.

◆ ALU3dGridEntitySeedBase() [1/5]

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

Constructor for EntitySeed that points to an element.

◆ ALU3dGridEntitySeedBase() [2/5]

template<int codim, class GridImp >
Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ALU3dGridEntitySeedBase ( const HElementType &  item)
inline

Constructor for EntitySeed that points to an element.

◆ ALU3dGridEntitySeedBase() [3/5]

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

Constructor for EntitySeed that points to an element.

◆ ALU3dGridEntitySeedBase() [4/5]

template<int codim, class GridImp >
Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ALU3dGridEntitySeedBase ( const HBndSegType &  ghostFace)
inline

Constructor for EntitySeed that points to an ghost.

◆ ALU3dGridEntitySeedBase() [5/5]

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

copy constructor

Member Function Documentation

◆ clear()

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

invalidate seed

◆ equals()

template<int codim, class GridImp >
bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::equals ( const ALU3dGridEntitySeedType &  i) const
inline

equality

◆ ghost()

template<int codim, class GridImp >
BNDFaceType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::ghost ( ) const
inline

◆ interior()

template<int codim, class GridImp >
HElementType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::interior ( ) const
inline

return iterior item

◆ isGhost()

template<int codim, class GridImp >
bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::isGhost ( ) const
inline

methods for ghosts

◆ isValid()

template<int codim, class GridImp >
bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::isValid ( ) const
inline

◆ item()

template<int codim, class GridImp >
HElementType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item ( ) const
inline

get item from key

◆ level()

template<int codim, class GridImp >
int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::level ( ) const
inline

◆ operator!=()

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

inequality operator

◆ operator=()

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

assignment operator

◆ operator==()

template<int codim, class GridImp >
bool Dune::ALU3dGridEntitySeedBase< codim, GridImp >::operator== ( const ALU3dGridEntitySeedType &  i) const
inline

equality operator

◆ set() [1/2]

template<int codim, class GridImp >
void Dune::ALU3dGridEntitySeedBase< codim, GridImp >::set ( const HBndSegType &  ghostFace)
inline

◆ set() [2/2]

template<int codim, class GridImp >
void Dune::ALU3dGridEntitySeedBase< codim, GridImp >::set ( const HElementType &  item)
inline

◆ toKey() [1/2]

template<int codim, class GridImp >
KeyType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::toKey ( const HBndSegType *  ghostFace)
inline

◆ toKey() [2/2]

template<int codim, class GridImp >
KeyType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::toKey ( const HElementType *  item)
inline

◆ twist()

template<int codim, class GridImp >
int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::twist ( ) const
inline

Member Data Documentation

◆ defaultTwist

template<int codim, class GridImp >
const int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::defaultTwist = 0
static

◆ defaultValue

template<int codim, class GridImp >
const int Dune::ALU3dGridEntitySeedBase< codim, GridImp >::defaultValue = -1
static

◆ item_

template<int codim, class GridImp >
KeyType* Dune::ALU3dGridEntitySeedBase< codim, GridImp >::item_
mutableprotected
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1