dune-grid  2.3.0
Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Dune::ALU3dGridHierarchicIndexSet< ALU3dGridElementType, class > Class Template Reference

hierarchic index set of ALU3dGrid More...

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

Inheritance diagram for Dune::ALU3dGridHierarchicIndexSet< ALU3dGridElementType, class >:
Dune::IndexSet< ALU3dGrid< elType, Comm >, ALU3dGridHierarchicIndexSet< elType, Comm > >

Public Types

typedef
GridType::Traits::template
Codim< 0 >::Entity 
EntityCodim0Type
 
typedef unsigned int IndexType
 The type used for the indices. More...
 

Public Member Functions

template<class EntityType >
int index (const EntityType &ep) const
 return hierarchic index of given entity More...
 
template<int codim>
int index (const typename GridType::Traits::template Codim< codim >::Entity &entity) const
 return hierarchic index of given entity More...
 
int subIndex (const EntityCodim0Type &e, int i, unsigned int codim) const
 return subIndex i of given entity for subEntity with codim More...
 
int size (GeometryType type) const
 
int size (int codim) const
 return size of indexset, i.e. maxindex+1 More...
 
const std::vector< GeometryType > & geomTypes (int codim) const
 deliver all geometry types used in this grid More...
 
template<class EntityType >
bool contains (const EntityType &) const
 return true because all entities are contained in this set More...
 
Index access from entity
IndexType index (const typename remove_const< ALU3dGrid< elType, Comm > >::type::Traits::template Codim< cc >::Entity &e) const
 Map entity to index. The result of calling this method with an entity that is not in the index set is undefined. More...
 
IndexType subIndex (const typename Traits::template Codim< cc >::Entity &e, int i, unsigned int codim) const
 Map a subentity to an index. More...
 
IndexType subIndex (const Entity &e, int i, unsigned int codim) const
 Map a subentity to an index. More...
 

Static Public Attributes

static const int dimension
 dimension of the grid (maximum allowed codimension) More...
 

Friends

class ALU3dGrid< elType, Comm >
 

Detailed Description

template<ALU3dGridElementType, class>
class Dune::ALU3dGridHierarchicIndexSet< ALU3dGridElementType, class >

hierarchic index set of ALU3dGrid

Member Typedef Documentation

template<ALU3dGridElementType , class >
typedef GridType::Traits::template Codim<0>::Entity Dune::ALU3dGridHierarchicIndexSet< ALU3dGridElementType, class >::EntityCodim0Type
typedef unsigned int Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , unsigned int >::IndexType
inherited

The type used for the indices.

Member Function Documentation

template<ALU3dGridElementType , class >
template<class EntityType >
bool Dune::ALU3dGridHierarchicIndexSet< ALU3dGridElementType, class >::contains ( const EntityType &  ) const
inline

return true because all entities are contained in this set

template<ALU3dGridElementType , class >
const std::vector<GeometryType>& Dune::ALU3dGridHierarchicIndexSet< ALU3dGridElementType, class >::geomTypes ( int  codim) const
inline

deliver all geometry types used in this grid

template<ALU3dGridElementType , class >
template<class EntityType >
int Dune::ALU3dGridHierarchicIndexSet< ALU3dGridElementType, class >::index ( const EntityType &  ep) const
inline

return hierarchic index of given entity

template<ALU3dGridElementType , class >
template<int codim>
int Dune::ALU3dGridHierarchicIndexSet< ALU3dGridElementType, class >::index ( const typename GridType::Traits::template Codim< codim >::Entity entity) const
inline

return hierarchic index of given entity

IndexType Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , unsigned int >::index ( const typename remove_const< ALU3dGrid< elType, Comm > >::type::Traits::template Codim< cc >::Entity e) const
inlineinherited

Map entity to index. The result of calling this method with an entity that is not in the index set is undefined.

Parameters
eReference to codim cc entity, where cc is the template parameter of the function.
Returns
An index in the range 0 ... Max number of entities in set - 1.
template<ALU3dGridElementType , class >
int Dune::ALU3dGridHierarchicIndexSet< ALU3dGridElementType, class >::size ( GeometryType  type) const
inline

return size of indexset, i.e. maxindex+1 for given type, if type is not exisiting within grid 0 is returned

Referenced by Dune::ALU3dGridHierarchicIndexSet< elType, Comm >::size().

template<ALU3dGridElementType , class >
int Dune::ALU3dGridHierarchicIndexSet< ALU3dGridElementType, class >::size ( int  codim) const
inline

return size of indexset, i.e. maxindex+1

template<ALU3dGridElementType , class >
int Dune::ALU3dGridHierarchicIndexSet< ALU3dGridElementType, class >::subIndex ( const EntityCodim0Type e,
int  i,
unsigned int  codim 
) const
inline

return subIndex i of given entity for subEntity with codim

IndexType Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , unsigned int >::subIndex ( const typename Traits::template Codim< cc >::Entity e,
int  i,
unsigned int  codim 
) const
inlineinherited

Map a subentity to an index.

The result of calling this method with an entity that is not in the index set is undefined.

Template Parameters
cccodimension of the entity
Parameters
[in]ereference to codimension cc entity
[in]inumber subentity of e within the codimension
[in]codimcodimension of the subentity we're interested in (must satisfy cc <= codim <= dimension)
Returns
An index in the range 0 ... Max number of entities in set - 1.
IndexType Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , unsigned int >::subIndex ( const Entity e,
int  i,
unsigned int  codim 
) const
inlineinherited

Map a subentity to an index.

The result of calling this method with an entity that is not in the index set is undefined.

Note
This method exists for convenience only. It extracts the codimension from the type of the entity, which can be guessed by the compiler.
Template Parameters
Entitytype of entity (must be GridImp::Codim< cc >::Entity for some cc)
Parameters
[in]ereference to entity
[in]inumber subentity of e within the codimension
[in]codimcodimension of the subentity we're interested in
Returns
An index in the range 0 ... Max number of entities in set - 1.

Friends And Related Function Documentation

template<ALU3dGridElementType , class >
friend class ALU3dGrid< elType, Comm >
friend

Member Data Documentation

const int Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , unsigned int >::dimension
staticinherited

dimension of the grid (maximum allowed codimension)


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