Dune Core Modules (2.4.1)

Dune::IdentityGridLevelIndexSet< GridImp > Class Template Reference

#include <dune/grid/identitygrid/identitygridindexsets.hh>

Public Types

typedef remove_const< GridImp >::type::HostGridType::LevelGridView::IndexSet::IndexType IndexType
 The type used for the indices.
 

Public Member Functions

template<int codim>
int index (const typename GridImp::Traits::template Codim< codim >::Entity &e) const
 get index of an entity
 
template<int cc>
int subIndex (const typename GridImp::Traits::template Codim< cc >::Entity &e, int i, int codim) const
 get index of subEntity of a codim 0 entity
 
int size (int codim) const
 get number of entities of given codim, type and on this level
 
int size (GeometryType type) const
 get number of entities of given codim, type and on this level
 
const std::vector< GeometryType > & geomTypes (int codim) const
 Deliver all geometry types used in this grid.
 
Types types (int codim) const
 Deliver all geometry types used in this grid.
 
template<class EntityType >
bool contains (const EntityType &e) const
 Return true if the given entity is contained in the index set.
 
void update (const GridImp &grid, int level)
 Set up the index set.
 
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...
 

Static Public Attributes

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

Detailed Description

template<class GridImp>
class Dune::IdentityGridLevelIndexSet< GridImp >
Todo:
Take the index types from the host grid

Member Function Documentation

◆ index() [1/2]

IndexType Dune::IndexSet< GridImp, IdentityGridLevelIndexSet< GridImp > , remove_const< GridImp >::type::HostGridType::LevelGridView::IndexSet::IndexType , remove_const< GridImp >::type::HostGridType::LevelGridView::IndexSet::Types >::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.

◆ index() [2/2]

IndexType Dune::IndexSet< GridImp, IdentityGridLevelIndexSet< GridImp > , remove_const< GridImp >::type::HostGridType::LevelGridView::IndexSet::IndexType , remove_const< GridImp >::type::HostGridType::LevelGridView::IndexSet::Types >::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.

◆ subIndex() [1/2]

IndexType Dune::IndexSet< GridImp, IdentityGridLevelIndexSet< GridImp > , remove_const< GridImp >::type::HostGridType::LevelGridView::IndexSet::IndexType , remove_const< GridImp >::type::HostGridType::LevelGridView::IndexSet::Types >::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< GridImp, IdentityGridLevelIndexSet< GridImp > , remove_const< GridImp >::type::HostGridType::LevelGridView::IndexSet::IndexType , remove_const< GridImp >::type::HostGridType::LevelGridView::IndexSet::Types >::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 file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Dec 22, 23:30, 2024)