Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp > Class Template Reference

Provide default implementation of method if IndexSet. More...

#include <dune/grid/common/indexidset.hh>

Public Types
typedef Base::IndexType	IndexType
	The type used for the indices.

Public Member Functions
Index access from entity
template<int cc>
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
IndexType	size (const 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. More...
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. More...
IndexType	index (const EntityType &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 Entity &e, int i, unsigned int codim) const
	Map a subentity to an index. More...
Access to entity set
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\). More...
IndexType	size (GeometryType type) const
	Return total number of entities of given geometry type in entity set \(E\). More...
bool	contains (const EntityType &e) const
	Return true if the given entity is contained in \(E\). More...

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

Detailed Description

template<class GridImp, class IndexSetImp>
class Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >

Provide default implementation of method if IndexSet.

Member Function Documentation

contains()

bool Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp >::contains ( const EntityType &  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.

geomTypes()

const std::vector< GeometryType > & Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp >::geomTypes ( int  codim ) const

inlineinherited

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.

index() [1/2]

IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp >::index ( const EntityType &  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, IndexSetImp, IndexTypeImp >::index ( const typename remove_const< GridImp >::type::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() [1/2]

template<class GridImp , class IndexSetImp >

IndexType Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >::size ( const 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.

References Dune::IndexSet< GridImp, IndexSetImp >::geomTypes(), and Dune::IndexSet< GridImp, IndexSetImp >::size().

size() [2/2]

IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp >::size ( GeometryType  type ) const

inlineinherited

Return total number of entities of given geometry type in entity set \(E\).

Parameters

[in]

type

A valid geometry type.

Returns

number of entities.

subIndex() [1/2]

IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp >::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

Returns

An index in the range 0 ... Max number of entities in set - 1.

subIndex() [2/2]

template<class GridImp , class IndexSetImp >

template<int cc>

IndexType Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >::subIndex ( const typename Traits::template Codim< cc >::Entity &  e, int  i, unsigned int  codim  ) const

inline

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 (must satisfy cc <= codim <= dimension)

Returns

An index in the range 0 ... Max number of entities in set - 1.

The default implementation is as follows:

index( *(e.subEntity( i, codim )) );

It does only work for cc=0 since the subEntity method is not present otherwise.

References DUNE_THROW.

---

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

• dune/grid/common/indexidset.hh