Dune::ALU3dGridHierarchicIndexSet< dim, dimworld, elType, Comm > Class Template Reference

hierarchic index set of ALU3dGrid More...

#include <dune/alugrid/3d/indexsets.hh>

Public Types
typedef IndexTypeImp	IndexType
	The type used for the indices.
typedef TypesImp	Types
	iterator range for geometry types in domain

Public Member Functions
template<class EntityType >
int	index (const EntityType &ep) const
	return hierarchic index of given entity
template<int codim>
int	index (const typename GridType::Traits::template Codim< codim >::Entity &entity) const
	return hierarchic index of given entity
template<int cd>
int	subIndex (const typename GridType::Traits::template Codim< cd >::Entity &e, int i, unsigned int codim) const
	return subIndex i of given entity for subEntity with codim
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 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...
Access to entity set
Types	types (int codim) const
	obtain all geometry types of entities in domain More...
bool	contains (const Entity &e) const
	Return true if the given entity is contained in \(E\). More...

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

Detailed Description

template<int dim, int dimworld, ALU3dGridElementType elType, class Comm>
class Dune::ALU3dGridHierarchicIndexSet< dim, dimworld, elType, Comm >

hierarchic index set of ALU3dGrid

Member Function Documentation

contains()

bool Dune::IndexSet< ALU3dGrid< dim, dimworld, elType, Comm > , ALU3dGridHierarchicIndexSet< dim, dimworld, elType, Comm > , IndexTypeImp, TypesImp >::contains ( const Entity &  e ) const

inlineinherited

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.

index() [1/2]

IndexType Dune::IndexSet< ALU3dGrid< dim, dimworld, elType, Comm > , ALU3dGridHierarchicIndexSet< dim, dimworld, elType, Comm > , IndexTypeImp, TypesImp >::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

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.

index() [2/2]

IndexType Dune::IndexSet< ALU3dGrid< dim, dimworld, elType, Comm > , ALU3dGridHierarchicIndexSet< dim, dimworld, elType, Comm > , IndexTypeImp, TypesImp >::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

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.

size()

template<int dim, int dimworld, ALU3dGridElementType elType, class Comm >

int Dune::ALU3dGridHierarchicIndexSet< dim, dimworld, elType, Comm >::size ( GeometryType  type ) const

inline

return size of indexset, i.e. maxindex+1 for given type, if type is not exisiting within grid 0 is returned

References Dune::GeometryType::dim(), Dune::GeometryType::isCube(), and Dune::GeometryType::isSimplex().

subIndex()

IndexType Dune::IndexSet< ALU3dGrid< dim, dimworld, elType, Comm > , ALU3dGridHierarchicIndexSet< dim, dimworld, elType, Comm > , IndexTypeImp, TypesImp >::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

cc	codimension of the entity

Parameters

[in]	e	reference to codimension cc entity
[in]	i	number subentity of e within the codimension
[in]	codim	codimension 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()

Types Dune::IndexSet< ALU3dGrid< dim, dimworld, elType, Comm > , ALU3dGridHierarchicIndexSet< dim, dimworld, elType, Comm > , IndexTypeImp, TypesImp >::types ( int  codim ) const

inlineinherited

obtain all geometry types of entities in domain

This method returns an iterator range (something that behaves like Dune::IteratorRange) visiting all geometry types of codimension codim in the domain of the index map exactly once. The iterator must implement the concept of a forward iterator (in the sense of the STL). The elements in the iterator range are required to be of type Dune::GeometryType.

Parameters

[in]

codim

a valid codimension

Returns

iterator range over Const reference to a vector of geometry types.

---

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

• dune/alugrid/3d/grid.hh
• dune/alugrid/3d/indexsets.hh