dune-alugrid 2.8.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Dune::ALU3dGridEntityPointerBase< codim, GridImp > Class Template Reference

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

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

Public Types

enum  { codimension = codim }
 
typedef GridImp::template Codim< codimension >::Entity Entity
 type of Entity
 
typedef Entity EntityObject
 
typedef ALU3dGridEntity< codimension, dim, GridImp > EntityImp
 
typedef ThisType ALU3dGridEntityPointerType
 typedef of my type
 
typedef ALU3dGridEntityPointer< codimension, GridImp > EntityPointerImp
 make type of entity pointer implementation available in derived classes
 
typedef ALU3dGridEntitySeed< codimension, GridImp > ALU3dGridEntitySeedType
 type of entity seed
 

Public Member Functions

 ALU3dGridEntityPointerBase (const HElementType &item)
 Constructor for EntityPointer that points to an element.
 
 ALU3dGridEntityPointerBase (const HBndSegType &ghostFace)
 Constructor for EntityPointer that points to an ghost.
 
 ALU3dGridEntityPointerBase (const ALU3dGridEntitySeedType &seed)
 Constructor for EntityPointer that points to an ghost.
 
 ALU3dGridEntityPointerBase (const ALU3dGridEntityPointerType &org)
 copy constructor
 
bool equals (const ALU3dGridEntityPointerType &i) const
 equality
 
ThisTypeoperator= (const ThisType &org)
 assignment operator
 
Entitydereference () const
 dereferencing
 
int level () const
 ask for level of entities
 
 ALU3dGridEntityPointerBase ()
 default empty constructor
 

Protected Member Functions

void clone (const ALU3dGridEntityPointerType &org)
 
void done ()
 has to be called when iterator is finished
 
void updateGhostPointer (HBndSegType &ghostFace)
 
void updateEntityPointer (HElementType *item, int level=-1)
 
EntityImpentityImp () const
 

Protected Attributes

ALU3dGridEntitySeedType seed_
 
EntityObject entity_
 

Detailed Description

template<int codim, class GridImp>
class Dune::ALU3dGridEntityPointerBase< codim, GridImp >

Enables iteration over all entities of a given codimension and level of a grid.

Member Typedef Documentation

◆ ALU3dGridEntityPointerType

template<int codim, class GridImp >
typedef ThisType Dune::ALU3dGridEntityPointerBase< codim, GridImp >::ALU3dGridEntityPointerType

typedef of my type

◆ ALU3dGridEntitySeedType

template<int codim, class GridImp >
typedef ALU3dGridEntitySeed<codimension, GridImp> Dune::ALU3dGridEntityPointerBase< codim, GridImp >::ALU3dGridEntitySeedType

type of entity seed

◆ Entity

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

type of Entity

◆ EntityImp

template<int codim, class GridImp >
typedef ALU3dGridEntity<codimension,dim, GridImp> Dune::ALU3dGridEntityPointerBase< codim, GridImp >::EntityImp

◆ EntityObject

template<int codim, class GridImp >
typedef Entity Dune::ALU3dGridEntityPointerBase< codim, GridImp >::EntityObject

◆ EntityPointerImp

template<int codim, class GridImp >
typedef ALU3dGridEntityPointer<codimension,GridImp> Dune::ALU3dGridEntityPointerBase< codim, GridImp >::EntityPointerImp

make type of entity pointer implementation available in derived classes

Member Enumeration Documentation

◆ anonymous enum

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

Constructor & Destructor Documentation

◆ ALU3dGridEntityPointerBase() [1/5]

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

Constructor for EntityPointer that points to an element.

◆ ALU3dGridEntityPointerBase() [2/5]

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

Constructor for EntityPointer that points to an ghost.

◆ ALU3dGridEntityPointerBase() [3/5]

template<int codim, class GridImp >
Dune::ALU3dGridEntityPointerBase< codim, GridImp >::ALU3dGridEntityPointerBase ( const ALU3dGridEntitySeedType seed)
inline

Constructor for EntityPointer that points to an ghost.

◆ ALU3dGridEntityPointerBase() [4/5]

template<int codim, class GridImp >
Dune::ALU3dGridEntityPointerBase< codim, GridImp >::ALU3dGridEntityPointerBase ( const ALU3dGridEntityPointerType org)
inline

copy constructor

◆ ALU3dGridEntityPointerBase() [5/5]

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

default empty constructor

Member Function Documentation

◆ clone()

template<int codim, class GridImp >
void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::clone ( const ALU3dGridEntityPointerType org)
inlineprotected

◆ dereference()

template<int codim, class GridImp >
Entity & Dune::ALU3dGridEntityPointerBase< codim, GridImp >::dereference ( ) const
inline

dereferencing

◆ done()

template<int codim, class GridImp >
void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::done
inlineprotected

has to be called when iterator is finished

◆ entityImp()

template<int codim, class GridImp >
EntityImp & Dune::ALU3dGridEntityPointerBase< codim, GridImp >::entityImp ( ) const
inlineprotected

◆ equals()

template<int codim, class GridImp >
bool Dune::ALU3dGridEntityPointerBase< codim, GridImp >::equals ( const ALU3dGridEntityPointerType i) const
inline

equality

◆ level()

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

ask for level of entities

◆ operator=()

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

assignment operator

◆ updateEntityPointer()

template<int codim, class GridImp >
void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::updateEntityPointer ( HElementType *  item,
int  level = -1 
)
inlineprotected

◆ updateGhostPointer()

template<int codim, class GridImp >
void Dune::ALU3dGridEntityPointerBase< codim, GridImp >::updateGhostPointer ( HBndSegType &  ghostFace)
inlineprotected

Member Data Documentation

◆ entity_

template<int codim, class GridImp >
EntityObject Dune::ALU3dGridEntityPointerBase< codim, GridImp >::entity_
mutableprotected

◆ seed_

template<int codim, class GridImp >
ALU3dGridEntitySeedType Dune::ALU3dGridEntityPointerBase< codim, GridImp >::seed_
protected

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