Dune::AlbertaGridIndexSet< dim, dimworld > Class Template Reference

#include <dune/grid/albertagrid/indexsets.hh>

Inheritance diagram for Dune::AlbertaGridIndexSet< dim, dimworld >:
Inheritance graph

List of all members.

Classes

struct  Insert

Public Types

typedef AlbertaGrid< dim,
dimworld > 
Grid
typedef Base::IndexType IndexType
 The type used for the indices.
typedef Alberta::ElementInfo
< dimension
ElementInfo
typedef
Alberta::HierarchyDofNumbering
< dimension
DofNumbering

Public Member Functions

 AlbertaGridIndexSet (const DofNumbering &dofNumbering)
 ~AlbertaGridIndexSet ()
template<class Entity >
bool contains (const Entity &entity) const
template<int cc>
IndexType index (const typename Traits::template Codim< cc >::Entity &entity) const
 return hierarchic index of given entity
template<int cc>
IndexType subIndex (const typename Traits::template Codim< cc >::Entity &entity, int i, unsigned int codim) const
 return subIndex of given enitiy's sub entity
IndexType size (const GeometryType &type) const
IndexType size (int codim) const
 Return total number of entities of given codim in the entity set $E$. This is simply a sum over all geometry types.
const std::vector< GeometryType > & geomTypes (int codim) const
 Return vector with all geometry types of entities in domain of index map. Return a vector with all geometry types of a given codimension contained in the Entity set $E$.
template<class Iterator >
void update (const Iterator &begin, const Iterator &end)
Index access from entity

IndexType index (const typename remove_const< AlbertaGrid< dim, dimworld > >::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 Entity &e, int i, unsigned int codim) const
 Map a subentity to an index.
Access to entity set

IndexType size (GeometryType type) const
 Return total number of entities of given geometry type in entity set $E$.
bool contains (const EntityType &e) const
 Return true if the given entity is contained in $E$.

Static Public Attributes

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

template<int dim, int dimworld>
class Dune::AlbertaGridIndexSet< dim, dimworld >


Member Typedef Documentation

template<int dim, int dimworld>
typedef Alberta::HierarchyDofNumbering< dimension > Dune::AlbertaGridIndexSet< dim, dimworld >::DofNumbering
template<int dim, int dimworld>
typedef Alberta::ElementInfo< dimension > Dune::AlbertaGridIndexSet< dim, dimworld >::ElementInfo
template<int dim, int dimworld>
typedef AlbertaGrid< dim, dimworld > Dune::AlbertaGridIndexSet< dim, dimworld >::Grid
template<int dim, int dimworld>
typedef Base::IndexType Dune::AlbertaGridIndexSet< dim, dimworld >::IndexType

Constructor & Destructor Documentation

template<int dim, int dimworld>
Dune::AlbertaGridIndexSet< dim, dimworld >::AlbertaGridIndexSet ( const DofNumbering dofNumbering  )  [inline, explicit]
template<int dim, int dimworld>
Dune::AlbertaGridIndexSet< dim, dimworld >::~AlbertaGridIndexSet (  )  [inline]

Member Function Documentation

bool Dune::IndexSet< AlbertaGrid< dim, dimworld > , AlbertaGridIndexSet< dim, dimworld > , int >::contains ( const EntityType &  e  )  const [inline, inherited]

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.
template<int dim, int dimworld>
const std::vector< GeometryType >& Dune::AlbertaGridIndexSet< dim, dimworld >::geomTypes ( int  codim  )  const [inline]

Return vector with all geometry types of entities in domain of index map. Return a vector with all geometry types of a given codimension contained in the Entity set $E$.

Parameters:
[in] codim A valid codimension.
Returns:
Const reference to a vector of geometry types.

Reimplemented from Dune::IndexSet< AlbertaGrid< dim, dimworld >, AlbertaGridIndexSet< dim, dimworld >, int >.

References Dune::AlbertaGridIndexSet< dim, dimworld >::dimension.

template<int dim, int dimworld>
template<int cc>
IndexType Dune::AlbertaGridIndexSet< dim, dimworld >::index ( const typename Traits::template Codim< cc >::Entity entity  )  const [inline]
IndexType Dune::IndexSet< AlbertaGrid< dim, dimworld > , AlbertaGridIndexSet< dim, dimworld > , int >::index ( const typename remove_const< AlbertaGrid< dim, dimworld > >::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< AlbertaGrid< dim, dimworld > , AlbertaGridIndexSet< dim, dimworld > , 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>
IndexType Dune::AlbertaGridIndexSet< dim, dimworld >::size ( const GeometryType &  type  )  const [inline]
template<int dim, int dimworld>
IndexType Dune::AlbertaGridIndexSet< dim, dimworld >::size ( int  codim  )  const [inline]

Return total number of entities of given codim in the entity set $E$. This is simply a sum over all geometry types.

Parameters:
[in] codim A valid codimension
Returns:
number of entities.

Reimplemented from Dune::IndexSet< AlbertaGrid< dim, dimworld >, AlbertaGridIndexSet< dim, dimworld >, int >.

References Dune::AlbertaGridIndexSet< dim, dimworld >::dimension.

IndexType Dune::IndexSet< AlbertaGrid< dim, dimworld > , AlbertaGridIndexSet< dim, dimworld > , int >::size ( GeometryType  type  )  const [inline, inherited]

Return total number of entities of given geometry type in entity set $E$.

Parameters:
[in] type A valid geometry type.
Returns:
number of entities.
IndexType Dune::IndexSet< AlbertaGrid< dim, dimworld > , AlbertaGridIndexSet< dim, dimworld > , 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>
template<int cc>
IndexType Dune::AlbertaGridIndexSet< dim, dimworld >::subIndex ( const typename Traits::template Codim< cc >::Entity entity,
int  i,
unsigned int  codim 
) const [inline]

Member Data Documentation


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].