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

hierarchic index set of ALU2dGrid More...

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

Inheritance diagram for Dune::ALU2dGridHierarchicIndexSet< dim, dimworld, eltype >:
Inheritance graph

List of all members.

Public Types

typedef
GridType::Traits::template
Codim< 0 >::Entity 
EntityCodim0Type
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.
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)

Friends

class ALU2dGrid< dim, dimworld, eltype >

Detailed Description

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

hierarchic index set of ALU2dGrid


Member Typedef Documentation

template<int dim, int dimworld, ALU2DSPACE ElementType eltype>
typedef GridType::Traits::template Codim<0>::Entity Dune::ALU2dGridHierarchicIndexSet< dim, dimworld, eltype >::EntityCodim0Type
typedef int Dune::IndexSet< ALU2dGrid< dim, dimworld, eltype > , ALU2dGridHierarchicIndexSet< dim, dimworld, eltype > , int >::IndexType [inherited]

The type used for the indices.


Member Function Documentation

template<int dim, int dimworld, ALU2DSPACE ElementType eltype>
template<class EntityType >
bool Dune::ALU2dGridHierarchicIndexSet< dim, dimworld, eltype >::contains ( const EntityType &   )  const [inline]

return true because all entities are contained in this set

Reimplemented from Dune::IndexSet< ALU2dGrid< dim, dimworld, eltype >, ALU2dGridHierarchicIndexSet< dim, dimworld, eltype >, int >.

template<int dim, int dimworld, ALU2DSPACE ElementType eltype>
const std::vector<GeometryType>& Dune::ALU2dGridHierarchicIndexSet< dim, dimworld, eltype >::geomTypes ( int  codim  )  const [inline]
template<int dim, int dimworld, ALU2DSPACE ElementType eltype>
template<class Entity >
int Dune::ALU2dGridHierarchicIndexSet< dim, dimworld, eltype >::index ( const Entity entity  )  const [inline]

return hierarchic index of given entity

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 [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.
IndexType Dune::IndexSet< ALU2dGrid< dim, dimworld, eltype > , ALU2dGridHierarchicIndexSet< dim, dimworld, eltype > , int >::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.
template<int dim, int dimworld, ALU2DSPACE ElementType eltype>
template<int codim>
int Dune::ALU2dGridHierarchicIndexSet< dim, dimworld, eltype >::index ( const typename GridType::Traits::template Codim< codim >::Entity entity  )  const [inline]

return hierarchic index of given entity

Referenced by Dune::ALU2dGridLocalIdSet< dim, dimworld, elementType >::id().

template<int dim, int dimworld, ALU2DSPACE ElementType eltype>
int Dune::ALU2dGridHierarchicIndexSet< dim, dimworld, eltype >::size ( GeometryType  type  )  const [inline]
template<int dim, int dimworld, ALU2DSPACE ElementType eltype>
int Dune::ALU2dGridHierarchicIndexSet< dim, dimworld, eltype >::size ( int  codim  )  const [inline]
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 [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.
IndexType Dune::IndexSet< ALU2dGrid< dim, dimworld, eltype > , ALU2dGridHierarchicIndexSet< dim, dimworld, eltype > , int >::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.
template<int dim, int dimworld, ALU2DSPACE ElementType eltype>
int Dune::ALU2dGridHierarchicIndexSet< dim, dimworld, eltype >::subIndex ( const EntityCodim0Type e,
int  i,
unsigned int  codim 
) const [inline]

return subIndex of given entity for codim sub entity

Referenced by Dune::ALU2dGridLocalIdSet< dim, dimworld, elementType >::subId().


Friends And Related Function Documentation

template<int dim, int dimworld, ALU2DSPACE ElementType eltype>
friend class ALU2dGrid< dim, dimworld, eltype > [friend]

Member Data Documentation

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