dune-grid  2.7.0
Public Types | Public Member Functions | List of all members
Dune::YaspIndexSet< GridImp, isLeafIndexSet > Class Template Reference

Implementation of Level- and LeafIndexSets for YaspGrid. More...

#include <dune/grid/yaspgrid.hh>

Inheritance diagram for Dune::YaspIndexSet< GridImp, isLeafIndexSet >:
Inheritance graph

Public Types

typedef Base::IndexType IndexType
 

Public Member Functions

 YaspIndexSet (const GridImp &g, int l)
 Level grid view constructor stores reference to a grid and level. More...
 
 YaspIndexSet (const GridImp &g)
 Level grid view constructor stores reference to a grid and level. More...
 
template<int cc>
IndexType index (const typename std::remove_const< GridImp >::type::Traits::template Codim< cc >::Entity &e) const
 get index of an entity More...
 
template<int cc>
IndexType subIndex (const typename std::remove_const< GridImp >::type::Traits::template Codim< cc >::Entity &e, int i, unsigned int codim) const
 get index of subentity of an entity More...
 
int size (GeometryType type) const
 get number of entities of given type and level (the level is known to the object) More...
 
int size (int codim) const
 return size of set for a given codim More...
 
template<class EntityType >
bool contains (const EntityType &e) const
 return true if the given entity is contained in $E$. More...
 
std::vector< GeometryType > types (int codim) const
 
const std::vector< GeometryType > & geomTypes (int codim) const
 deliver all geometry types used in this grid More...
 
template<int cc>
IndexType subIndex (const typename Traits::template Codim< cc >::Entity &e, int i, unsigned int codim) const
 Map a subentity to an index. More...
 
template<class Entity >
IndexType subIndex (const Entity &e, int i, unsigned int codim) const
 Map a subentity to an index. More...
 

Detailed Description

template<class GridImp, bool isLeafIndexSet>
class Dune::YaspIndexSet< GridImp, isLeafIndexSet >

Implementation of Level- and LeafIndexSets for YaspGrid.

Template Parameters
GridImpThe YaspGrid class we are an index set for
isLeafIndexSetfalse: class functions as level index set, true: class functions as leaf index set

Member Typedef Documentation

◆ IndexType

template<class GridImp , bool isLeafIndexSet>
typedef Base::IndexType Dune::YaspIndexSet< GridImp, isLeafIndexSet >::IndexType

Constructor & Destructor Documentation

◆ YaspIndexSet() [1/2]

template<class GridImp , bool isLeafIndexSet>
Dune::YaspIndexSet< GridImp, isLeafIndexSet >::YaspIndexSet ( const GridImp &  g,
int  l 
)
inline

Level grid view constructor stores reference to a grid and level.

◆ YaspIndexSet() [2/2]

template<class GridImp , bool isLeafIndexSet>
Dune::YaspIndexSet< GridImp, isLeafIndexSet >::YaspIndexSet ( const GridImp &  g)
inline

Level grid view constructor stores reference to a grid and level.

Member Function Documentation

◆ contains()

template<class GridImp , bool isLeafIndexSet>
template<class EntityType >
bool Dune::YaspIndexSet< GridImp, isLeafIndexSet >::contains ( const EntityType &  e) const
inline

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

◆ geomTypes()

template<class GridImp , bool isLeafIndexSet>
const std::vector<GeometryType>& Dune::YaspIndexSet< GridImp, isLeafIndexSet >::geomTypes ( int  codim) const
inline

deliver all geometry types used in this grid

◆ index()

template<class GridImp , bool isLeafIndexSet>
template<int cc>
IndexType Dune::YaspIndexSet< GridImp, isLeafIndexSet >::index ( const typename std::remove_const< GridImp >::type::Traits::template Codim< cc >::Entity e) const
inline

get index of an entity

◆ size() [1/2]

template<class GridImp , bool isLeafIndexSet>
int Dune::YaspIndexSet< GridImp, isLeafIndexSet >::size ( GeometryType  type) const
inline

get number of entities of given type and level (the level is known to the object)

◆ size() [2/2]

template<class GridImp , bool isLeafIndexSet>
int Dune::YaspIndexSet< GridImp, isLeafIndexSet >::size ( int  codim) const
inline

return size of set for a given codim

◆ subIndex() [1/3]

template<class GridImp , bool isLeafIndexSet>
template<class Entity >
IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::subIndex ( class Entity  )
inline

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
Note
The parameter codim denotes the codimension with respect to the grid, i.e., it must satisfy cc <= codim <= dimension.
Returns
An index in the range 0 ... Max number of entities in set - 1.

◆ subIndex() [2/3]

template<class GridImp , bool isLeafIndexSet>
template<int cc>
IndexType Dune::YaspIndexSet< GridImp, isLeafIndexSet >::subIndex ( const typename std::remove_const< GridImp >::type::Traits::template Codim< cc >::Entity e,
int  i,
unsigned int  codim 
) const
inline

get index of subentity of an entity

◆ subIndex() [3/3]

template<class GridImp , bool isLeafIndexSet>
template<int cc>
IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::subIndex ( int  cc)
inline

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
Note
The parameter codim denotes the codimension with respect to the grid, i.e., it must satisfy cc <= codim <= dimension.
Returns
An index in the range 0 ... Max number of entities in set - 1.

◆ types()

template<class GridImp , bool isLeafIndexSet>
std::vector< GeometryType > Dune::YaspIndexSet< GridImp, isLeafIndexSet >::types ( int  codim) const
inline

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