#include <dune/grid/identitygrid/identitygridindexsets.hh>

Inheritance diagram for Dune::IdentityGridLeafIndexSet< GridImp >:

Public Types
typedef HostGrid::LevelGridView::IndexSet::Types	Types

typedef std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::IndexType	IndexType
	The type used for the indices.

Public Member Functions
	IdentityGridLeafIndexSet (const GridImp &grid)
	constructor stores reference to a grid and level

template<int codim>
int	index (const typename std::remove_const< GridImp >::type::template Codim< codim >::Entity &e) const
	get index of an entity

template<int cc>
int	subIndex (const typename std::remove_const< GridImp >::type::Traits::template Codim< cc >::Entity &e, int i, int codim) const
	get index of subEntity of a codim 0 entity

std::size_t	size (GeometryType type) const
	get number of entities of given type

std::size_t	size (int codim) const
	get number of entities of given codim

Types	types (int codim) const
	Deliver all geometry types used in this grid.

template<class EntityType >
bool	contains (const EntityType &e) const
	Return true if the given entity is contained in the index set.

void	update (const GridImp &grid)

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.

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.

IndexType	subIndex (const typename Traits::template Codim< cc >::Entity &e, int i, unsigned int codim) const
	Map a subentity to an index.

IndexType	subIndex (const Entity &e, int i, unsigned int codim) const
	Map a subentity to an index.

Access to entity set
bool	contains (const Entity &e) const
	Return true if the given entity is contained in \(E\).

Public Attributes
GridImp *	grid_

Static Public Attributes
static constexpr int	dim = std::remove_const<GridImp>::type::dimension

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

Member Typedef Documentation

◆ IndexType

typedef std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::IndexType Dune::IndexSet< GridImp, IdentityGridLeafIndexSet< GridImp > , std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::IndexType , std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::Types >::IndexType

inherited

The type used for the indices.

◆ Types

template<class GridImp >

typedef HostGrid::LevelGridView::IndexSet::Types Dune::IdentityGridLeafIndexSet< GridImp >::Types

Constructor & Destructor Documentation

◆ IdentityGridLeafIndexSet()

template<class GridImp >

Dune::IdentityGridLeafIndexSet< GridImp >::IdentityGridLeafIndexSet ( const GridImp & grid )

inline

constructor stores reference to a grid and level

Member Function Documentation

◆ contains() [1/2]

bool Dune::IndexSet< GridImp, IdentityGridLeafIndexSet< GridImp > , std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::IndexType , std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::Types >::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.

◆ contains() [2/2]

template<class GridImp >

template<class EntityType >

bool Dune::IdentityGridLeafIndexSet< GridImp >::contains ( const EntityType & e ) const

inline

Return true if the given entity is contained in the index set.

◆ index() [1/3]

IndexType Dune::IndexSet< GridImp, IdentityGridLeafIndexSet< GridImp > , std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::IndexType , std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::Types >::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/3]

template<class GridImp >

template<int codim>

int Dune::IdentityGridLeafIndexSet< GridImp >::index ( const typename std::remove_const< GridImp >::type::template Codim< codim >::Entity & e ) const

inline

get index of an entity

◆ index() [3/3]

IndexType Dune::IndexSet< GridImp, IdentityGridLeafIndexSet< GridImp > , std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::IndexType , std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::Types >::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() [1/2]

template<class GridImp >

std::size_t Dune::IdentityGridLeafIndexSet< GridImp >::size ( GeometryType type ) const

inline

get number of entities of given type

◆ size() [2/2]

template<class GridImp >

std::size_t Dune::IdentityGridLeafIndexSet< GridImp >::size ( int codim ) const

inline

get number of entities of given codim

◆ subIndex() [1/3]

IndexType Dune::IndexSet< GridImp, IdentityGridLeafIndexSet< GridImp > , std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::IndexType , std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::Types >::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 >

template<int cc>

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

inline

get index of subEntity of a codim 0 entity

◆ subIndex() [3/3]

IndexType Dune::IndexSet< GridImp, IdentityGridLeafIndexSet< GridImp > , std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::IndexType , std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::Types >::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()

template<class GridImp >

Types Dune::IdentityGridLeafIndexSet< GridImp >::types ( int codim ) const

inline

Deliver all geometry types used in this grid.

◆ update()

template<class GridImp >

void Dune::IdentityGridLeafIndexSet< GridImp >::update ( const GridImp & grid )

inline

Todo:: Currently we support only vertex and element indices

Member Data Documentation

◆ dim

template<class GridImp >

constexpr int Dune::IdentityGridLeafIndexSet< GridImp >::dim = std::remove_const<GridImp>::type::dimension

staticconstexpr

◆ dimension

const int Dune::IndexSet< GridImp, IdentityGridLeafIndexSet< GridImp > , std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::IndexType , std::remove_const< GridImp >::type::HostGridType::LeafGridView::IndexSet::Types >::dimension

staticinherited

dimension of the grid (maximum allowed codimension)

◆ grid_

template<class GridImp >

GridImp* Dune::IdentityGridLeafIndexSet< GridImp >::grid_

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

identitygridindexsets.hh

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Member Typedef Documentation

◆ IndexType

◆ Types

Constructor & Destructor Documentation

◆ IdentityGridLeafIndexSet()

Member Function Documentation

◆ contains() [1/2]

◆ contains() [2/2]

◆ index() [1/3]

◆ index() [2/3]

◆ index() [3/3]

◆ size() [1/2]

◆ size() [2/2]

◆ subIndex() [1/3]

◆ subIndex() [2/3]

◆ subIndex() [3/3]

◆ types()

◆ update()

Member Data Documentation

◆ dim

◆ dimension

◆ grid_