Dune Core Modules (2.3.1)

Dune::ALU2dGridHierarchicIndexSet< dim, dimworld, eltype > Class Template Reference

hierarchic index set of ALU2dGrid More...

#include <dune/grid/alugrid/2d/indexsets.hh>

Public Types

typedef int IndexType
 The type used for the indices.
 

Public Member Functions

template<int codim>
int index (const typename GridType::Traits::template Codim< codim >::Entity &entity) const
 return hierarchic index of given entity
 
template<class Entity >
int index (const Entity &entity) const
 return hierarchic index of given entity
 
int subIndex (const EntityCodim0Type &e, int i, unsigned int codim) const
 return subIndex of given entity for codim sub entity
 
int size (GeometryType type) const
 
int size (int codim) const
 return size of indexset, i.e. maxindex+1
 
const std::vector< GeometryType > & geomTypes (int codim) const
 deliver all geometry types used in this grid
 
template<class EntityType >
bool contains (const EntityType &) const
 return true because all entities are contained in this set
 
Index access from entity
IndexType index (const typename remove_const< ALU2dGrid< dim, dimworld, eltype > >::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 index (const EntityType &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...
 

Static Public Attributes

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

Detailed Description

template<int dim, int dimworld, ALU2DSPACE ElementType eltype>
class Dune::ALU2dGridHierarchicIndexSet< dim, dimworld, eltype >

hierarchic index set of ALU2dGrid

Member Function Documentation

◆ index() [1/2]

IndexType Dune::IndexSet< ALU2dGrid< dim, dimworld, eltype > , ALU2dGridHierarchicIndexSet< dim, dimworld, eltype > , int >::index ( const EntityType &  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.

◆ index() [2/2]

IndexType Dune::IndexSet< ALU2dGrid< dim, dimworld, eltype > , ALU2dGridHierarchicIndexSet< dim, dimworld, eltype > , int >::index ( const typename remove_const< ALU2dGrid< dim, dimworld, eltype > >::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.

◆ size()

template<int dim, int dimworld, ALU2DSPACE ElementType eltype>
int Dune::ALU2dGridHierarchicIndexSet< dim, dimworld, eltype >::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

◆ subIndex() [1/2]

IndexType Dune::IndexSet< ALU2dGrid< dim, dimworld, eltype > , ALU2dGridHierarchicIndexSet< dim, dimworld, eltype > , 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.

◆ subIndex() [2/2]

IndexType Dune::IndexSet< ALU2dGrid< dim, dimworld, eltype > , ALU2dGridHierarchicIndexSet< dim, dimworld, eltype > , 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.

The documentation for this class was generated from the following files:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (May 14, 22:30, 2024)