dune-grid  2.4.1-rc2
Public Types | Public Member Functions | Static Public Attributes | List of all members
Dune::ALU3dGridHierarchicIndexSet< elType, Comm > Class Template Reference

hierarchic index set of ALU3dGrid More...

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

Inheritance diagram for Dune::ALU3dGridHierarchicIndexSet< elType, Comm >:
Inheritance graph

Public Types

typedef GridType::Traits::template Codim< 0 >::Entity EntityCodim0Type
 
typedef IndexTypeImp IndexType
 The type used for the indices. More...
 
typedef TypesImp Types
 iterator range for geometry types in domain 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 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 index (const Entity &e) const
 Map entity to index. Easier to use than the above because codimension template parameter need not be supplied explicitly. 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...
 
Access to entity set
Types types (int codim) const
 obtain all geometry types of entities in domain More...
 
bool contains (const Entity &e) const
 Return true if the given entity is contained in $E$. More...
 

Static Public Attributes

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

Detailed Description

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

hierarchic index set of ALU3dGrid

Member Typedef Documentation

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

The type used for the indices.

typedef TypesImp Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , IndexTypeImp, TypesImp >::Types
inherited

iterator range for geometry types in domain

Member Function Documentation

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

return true because all entities are contained in this set

bool Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , IndexTypeImp, TypesImp >::contains ( const Entity e) const
inlineinherited

Return true if the given entity is contained in $E$.

Note
If the input element e is not an element of the grid, then the result of contains() is undefined.
template<ALU3dGridElementType elType, class Comm >
const std::vector<GeometryType>& Dune::ALU3dGridHierarchicIndexSet< elType, Comm >::geomTypes ( int  codim) const
inline

deliver all geometry types used in this grid

References Dune::ALU3dGrid< elType, Comm >::geomTypes().

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

return hierarchic index of given entity

template<ALU3dGridElementType elType, class Comm >
template<int codim>
int Dune::ALU3dGridHierarchicIndexSet< elType, Comm >::index ( const typename GridType::Traits::template Codim< codim >::Entity entity) const
inline
IndexType Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , IndexTypeImp, TypesImp >::index ( const typename 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.
IndexType Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , IndexTypeImp, TypesImp >::index ( const Entity e) const
inlineinherited

Map entity to index. Easier to use than the above because codimension template parameter need not be supplied explicitly. The result of calling this method with an entity that is not in the index set is undefined.

Parameters
eReference to codim cc entity. Since entity knows its codimension, automatic extraction is possible.
Returns
An index in the range 0 ... Max number of entities in set - 1.
template<ALU3dGridElementType elType, class Comm >
int Dune::ALU3dGridHierarchicIndexSet< elType, Comm >::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

References Dune::ALU3dGrid< elType, Comm >::dimension, Dune::hexa, and Dune::tetra.

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

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

References Dune::ALU3dGrid< elType, Comm >::hierSetSize().

template<ALU3dGridElementType elType, class Comm >
int Dune::ALU3dGridHierarchicIndexSet< elType, Comm >::subIndex ( const EntityCodim0Type e,
int  i,
unsigned int  codim 
) const
inline
IndexType Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , IndexTypeImp, TypesImp >::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 > , IndexTypeImp, TypesImp >::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.
Types Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , IndexTypeImp, TypesImp >::types ( int  codim) const
inlineinherited

obtain all geometry types of entities in domain

This method returns an iterator range (something that behaves like Dune::IteratorRange) visiting all geometry types of codimension codim in the domain of the index map exactly once. The iterator must implement the concept of a forward iterator (in the sense of the STL). The elements in the iterator range are required to be of type Dune::GeometryType.

Parameters
[in]codima valid codimension
Returns
iterator range over Const reference to a vector of geometry types.

Member Data Documentation

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

dimension of the grid (maximum allowed codimension)


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