Dune::SGridLeafIndexSet< GridImp > Class Template Reference

#include <dune/grid/sgrid.hh>

Inheritance diagram for Dune::SGridLeafIndexSet< GridImp >:
Inheritance graph

List of all members.

Public Types

typedef IndexTypeImp IndexType
 The type used for the indices.

Public Member Functions

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

IndexType index (const typename remove_const< GridImp >::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.
IndexType index (const EntityType &e) const
 Map entity to index. Easier to use than the above because codimension template parameter need not be supplied explicitely. The result of calling this method with an entity that is not in the index set is undefined.
IndexType subIndex (const typename Traits::template Codim< cc >::Entity &e, int i, unsigned int codim) const
 Map a subentity to an index.
IndexType subIndex (const Entity &e, int i, unsigned int codim) const
 Map a subentity to an index.

Static Public Attributes

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

template<class GridImp>
class Dune::SGridLeafIndexSet< GridImp >


Member Typedef Documentation

typedef IndexTypeImp Dune::IndexSet< GridImp, SGridLeafIndexSet< GridImp > , IndexTypeImp >::IndexType [inherited]

The type used for the indices.


Constructor & Destructor Documentation

template<class GridImp>
Dune::SGridLeafIndexSet< GridImp >::SGridLeafIndexSet ( const GridImp &  g  )  [inline, explicit]

constructor stores reference to a grid and level


Member Function Documentation

template<class GridImp>
template<class EntityType >
bool Dune::SGridLeafIndexSet< GridImp >::contains ( const EntityType &  e  )  const [inline]

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.

Reimplemented from Dune::IndexSet< GridImp, SGridLeafIndexSet< GridImp > >.

template<class GridImp>
const std::vector<GeometryType>& Dune::SGridLeafIndexSet< GridImp >::geomTypes ( int  codim  )  const [inline]

deliver all geometry types used in this grid

Reimplemented from Dune::IndexSet< GridImp, SGridLeafIndexSet< GridImp > >.

template<class GridImp>
template<int cd>
int Dune::SGridLeafIndexSet< GridImp >::index ( const typename remove_const< GridImp >::type::Traits::template Codim< cd >::Entity e  )  const [inline]

get index of an entity

IndexType Dune::IndexSet< GridImp, SGridLeafIndexSet< GridImp > , IndexTypeImp >::index ( const EntityType &  e  )  const [inline, inherited]

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

Parameters:
e Reference 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.
IndexType Dune::IndexSet< GridImp, SGridLeafIndexSet< GridImp > , IndexTypeImp >::index ( const typename remove_const< GridImp >::type::Traits::template Codim< cc >::Entity e  )  const [inline, inherited]

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

Parameters:
e Reference 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<class GridImp>
int Dune::SGridLeafIndexSet< GridImp >::size ( int  codim  )  const [inline]

return size of set for a given codim

Reimplemented from Dune::IndexSet< GridImp, SGridLeafIndexSet< GridImp > >.

template<class GridImp>
int Dune::SGridLeafIndexSet< GridImp >::size ( GeometryType  type  )  const [inline]

get number of entities of given type

Reimplemented from Dune::IndexSet< GridImp, SGridLeafIndexSet< GridImp > >.

IndexType Dune::IndexSet< GridImp, SGridLeafIndexSet< GridImp > , IndexTypeImp >::subIndex ( const typename Traits::template Codim< cc >::Entity e,
int  i,
unsigned int  codim 
) const [inline, inherited]

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:
cc codimension of the entity
Parameters:
[in] e reference to codimsion cc entity
[in] i number subentity of e within the codimension
[in] codim codimension 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.
template<class GridImp>
template<int cc>
int Dune::SGridLeafIndexSet< GridImp >::subIndex ( const typename GridImp::Traits::template Codim< cc >::Entity e,
int  i,
unsigned int  codim 
) const [inline]
IndexType Dune::IndexSet< GridImp, SGridLeafIndexSet< GridImp > , IndexTypeImp >::subIndex ( const Entity e,
int  i,
unsigned int  codim 
) const [inline, inherited]

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:
Entity type of entity (must be GridImp::Codim< cc >::Entity for some cc)
Parameters:
[in] e reference to entity
[in] i number subentity of e within the codimension
[in] codim codimension of the subentity we're interested in
Returns:
An index in the range 0 ... Max number of entities in set - 1.

Member Data Documentation

const int Dune::IndexSet< GridImp, SGridLeafIndexSet< GridImp > , IndexTypeImp >::dimension [static, inherited]

dimension of the grid (maximum allowed codimension)


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

Generated on Fri Apr 29 2011 with Doxygen (ver 1.7.1) [doxygen-log,error-log].