Dune::YaspPersistentContainerIndex< Grid > Class Template Reference

#include <dune/grid/yaspgrid/yaspgridpersistentcontainer.hh>

Inheritance diagram for Dune::YaspPersistentContainerIndex< Grid >:

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

Public Member Functions
	YaspPersistentContainerIndex (const Grid &grid, int codim)
template<class Entity >
IndexType	index (const 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.
template<class Entity >
IndexType	subIndex (const Entity &e, int i, unsigned int codim) const
	Map a subentity to an index.
std::size_t	size (int) const
	Return total number of entities of given geometry type in entity set \(E\).

Member Typedef Documentation

IndexType

template<typename Grid >

typedef std::size_t Dune::YaspPersistentContainerIndex< Grid >::IndexType

The type used for the indices.

Constructor & Destructor Documentation

YaspPersistentContainerIndex()

template<typename Grid >

Dune::YaspPersistentContainerIndex< Grid >::YaspPersistentContainerIndex ( const Grid &  grid, int  codim  )

inline

Member Function Documentation

index()

template<typename Grid >

template<class Entity >

IndexType Dune::YaspPersistentContainerIndex< Grid >::index ( const Entity &  e ) const

inline

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<typename Grid >

std::size_t Dune::YaspPersistentContainerIndex< Grid >::size ( int  ) const

inline

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

Parameters

[in]

type

A valid geometry type.

Returns

number of entities (type is auto determined by the implementation. std::size_t is the expected return type).

subIndex()

template<typename Grid >

template<class Entity >

IndexType Dune::YaspPersistentContainerIndex< Grid >::subIndex ( const 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

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 files:

• yaspgrid.hh
• yaspgridpersistentcontainer.hh