Dune::DefaultIndexSet< GridImp, IteratorImp > Class Template Reference

DefaultIndexSet creates an index set by using the grids persistent container an a given pair of iterators. More...

#include <dune/alugrid/common/defaultindexsets.hh>

Public Types
typedef unsigned int	IndexType
	type of index
typedef std::vector< GeometryType >	Types
	type of geometry types

Public Member Functions
	DefaultIndexSet (const GridType &grid, const IteratorType &begin, const IteratorType &end, const int level=-1)
template<class EntityType >
IndexType	index (const EntityType &en) const
	return LevelIndex of given entity
template<int cd>
IndexType	index (const typename GridImp::template Codim< cd >::Entity &en) const
	return LevelIndex of given entity
template<int cc>
IndexType	subIndex (const typename std::remove_const< GridImp >::type::Traits::template Codim< cc >::Entity &e, int i, unsigned int codim) const
template<class EntityType >
bool	contains (const EntityType &en) const
	returns true if this set provides an index for given entity
IndexType	size (int codim) const
	return size of IndexSet for a given level and codim
IndexType	size (GeometryType type) const
void	calcNewIndex (const IteratorType &begin, const IteratorType &end)
const std::vector< GeometryType > &	geomTypes (int codim) const
	deliver all geometry types used in this grid
Types	types (const int codim) const
	deliver all geometry types used in this grid
bool	containsIndex (const int cd, const int idx) const
	returns true if this set provides an index for given entity
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...
IndexType	subIndex (const Entity &e, int i, unsigned int codim) const
	Map a subentity to an index. More...
Access to entity set
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<class GridImp, class IteratorImp>
class Dune::DefaultIndexSet< GridImp, IteratorImp >

DefaultIndexSet creates an index set by using the grids persistent container an a given pair of iterators.

Constructor & Destructor Documentation

DefaultIndexSet()

template<class GridImp , class IteratorImp >

Dune::DefaultIndexSet< GridImp, IteratorImp >::DefaultIndexSet ( const GridType &  grid, const IteratorType &  begin, const IteratorType &  end, const int  level = -1  )

inline

create index set by using the given begin and end iterator for the given level (level == -1 means leaf level)

References Dune::DefaultIndexSet< GridImp, IteratorImp >::calcNewIndex().

Member Function Documentation

calcNewIndex()

template<class GridImp , class IteratorImp >

void Dune::DefaultIndexSet< GridImp, IteratorImp >::calcNewIndex ( const IteratorType &  begin, const IteratorType &  end  )

inline

do calculation of the index set, has to be called when grid was changed or if index set is created

Referenced by Dune::DefaultIndexSet< GridImp, IteratorImp >::DefaultIndexSet().

contains()

bool Dune::IndexSet< GridImp, DefaultIndexSet< GridImp, IteratorImp > , unsigned int , std::vector< GeometryType > >::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< GridImp, DefaultIndexSet< GridImp, IteratorImp > , unsigned int , std::vector< GeometryType > >::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< GridImp, DefaultIndexSet< GridImp, IteratorImp > , unsigned int , std::vector< GeometryType > >::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<class GridImp , class IteratorImp >

IndexType Dune::DefaultIndexSet< GridImp, IteratorImp >::size ( GeometryType  type ) const

inline

return size of IndexSet for a given level and codim this method is to be revised

References Dune::GeometryType::dim().

subIndex() [1/3]

IndexType Dune::IndexSet< GridImp, DefaultIndexSet< GridImp, IteratorImp > , unsigned int , std::vector< GeometryType > >::subIndex ( const 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.

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

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 , class IteratorImp >

template<int cc>

IndexType Dune::DefaultIndexSet< GridImp, IteratorImp >::subIndex ( const typename std::remove_const< GridImp >::type::Traits::template Codim< cc >::Entity &  e, int  i, unsigned int  codim  ) const

inline

return subIndex (LevelIndex) for a given Entity of codim = 0 and a given SubEntity codim and number of SubEntity

subIndex() [3/3]

IndexType Dune::IndexSet< GridImp, DefaultIndexSet< GridImp, IteratorImp > , unsigned int , std::vector< GeometryType > >::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.

---

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

• dune/alugrid/common/defaultindexsets.hh