Implementation of Level- and LeafIndexSets for YaspGrid. More...

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

Inheritance diagram for Dune::YaspIndexSet< GridImp, isLeafIndexSet >:

Public Types
typedef Base::IndexType	IndexType

typedef std::array< GeometryType, 1 >	Types
	iterator range for geometry types in domain

Public Member Functions
	YaspIndexSet (const GridImp &g, int l)
	Level grid view constructor stores reference to a grid and level.

	YaspIndexSet (const GridImp &g)
	Level grid view constructor stores reference to a grid and level.

template<int cc>
IndexType	index (const typename std::remove_const< GridImp >::type::Traits::template Codim< cc >::Entity &e) const
	get index of an 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
	get index of subentity of an entity

std::size_t	size (GeometryType type) const
	get number of entities of given type and level (the level is known to the object)

std::size_t	size (int codim) const
	return size of set for a given codim

template<class EntityType >
bool	contains (const EntityType &e) const
	return true if the given entity is contained in \(E\).

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.

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

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.

Access to entity set
Types	types (int codim) const
	obtain all geometry types of entities in domain

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

Static Public Member Functions
static constexpr std::array< GeometryType, 1 >	types (int codim)
	obtain all geometry types of entities in domain

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

Detailed Description

template<class GridImp, bool isLeafIndexSet>
class Dune::YaspIndexSet< GridImp, isLeafIndexSet >

Implementation of Level- and LeafIndexSets for YaspGrid.

Template Parameters

GridImp	The YaspGrid class we are an index set for
isLeafIndexSet	false: class functions as level index set, true: class functions as leaf index set

Member Typedef Documentation

◆ IndexType

template<class GridImp , bool isLeafIndexSet>

typedef Base::IndexType Dune::YaspIndexSet< GridImp, isLeafIndexSet >::IndexType

◆ Types

typedef std::array< GeometryType, 1 > Dune::IndexSet< GridImp, YaspIndexSet< GridImp, isLeafIndexSet > , unsigned int , std::array< GeometryType, 1 > >::Types

inherited

iterator range for geometry types in domain

Constructor & Destructor Documentation

◆ YaspIndexSet() [1/2]

template<class GridImp , bool isLeafIndexSet>

Dune::YaspIndexSet< GridImp, isLeafIndexSet >::YaspIndexSet	(	const GridImp &	g,
		int	l
	)

inline

Level grid view constructor stores reference to a grid and level.

◆ YaspIndexSet() [2/2]

template<class GridImp , bool isLeafIndexSet>

Dune::YaspIndexSet< GridImp, isLeafIndexSet >::YaspIndexSet ( const GridImp & g )

inline

Level grid view constructor stores reference to a grid and level.

Member Function Documentation

◆ contains() [1/2]

bool Dune::IndexSet< GridImp, YaspIndexSet< GridImp, isLeafIndexSet > , unsigned int , std::array< GeometryType, 1 > >::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 , bool isLeafIndexSet>

template<class EntityType >

bool Dune::YaspIndexSet< GridImp, isLeafIndexSet >::contains ( const EntityType & e ) const

inline

return true if the given entity is contained in \(E\).

◆ index() [1/3]

IndexType Dune::IndexSet< GridImp, YaspIndexSet< GridImp, isLeafIndexSet > , unsigned int , std::array< GeometryType, 1 > >::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 , bool isLeafIndexSet>

template<int cc>

IndexType Dune::YaspIndexSet< GridImp, isLeafIndexSet >::index ( const typename std::remove_const< GridImp >::type::Traits::template Codim< cc >::Entity & e ) const

inline

get index of an entity

◆ index() [3/3]

IndexType Dune::IndexSet< GridImp, YaspIndexSet< GridImp, isLeafIndexSet > , unsigned int , std::array< GeometryType, 1 > >::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 , bool isLeafIndexSet>

std::size_t Dune::YaspIndexSet< GridImp, isLeafIndexSet >::size ( GeometryType type ) const

inline

get number of entities of given type and level (the level is known to the object)

◆ size() [2/2]

template<class GridImp , bool isLeafIndexSet>

std::size_t Dune::YaspIndexSet< GridImp, isLeafIndexSet >::size ( int codim ) const

inline

return size of set for a given codim

◆ subIndex() [1/3]

template<class GridImp , bool isLeafIndexSet>

template<class Entity >

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

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 , bool isLeafIndexSet>

template<int cc>

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

inline

get index of subentity of an entity

◆ subIndex() [3/3]

template<class GridImp , bool isLeafIndexSet>

template<int cc>

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

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() [1/2]

template<class GridImp , bool isLeafIndexSet>

static constexpr std::array< GeometryType, 1 > Dune::YaspIndexSet< GridImp, isLeafIndexSet >::types ( int codim )

inlinestaticconstexpr

obtain all geometry types of entities in domain

◆ types() [2/2]

Types Dune::IndexSet< GridImp, YaspIndexSet< GridImp, isLeafIndexSet > , unsigned int , std::array< GeometryType, 1 > >::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.

Member Data Documentation

◆ dimension

const int Dune::IndexSet< GridImp, YaspIndexSet< GridImp, isLeafIndexSet > , unsigned int , std::array< GeometryType, 1 > >::dimension

staticinherited

dimension of the grid (maximum allowed codimension)

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ IndexType

◆ Types

Constructor & Destructor Documentation

◆ YaspIndexSet() [1/2]

◆ YaspIndexSet() [2/2]

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() [1/2]

◆ types() [2/2]

Member Data Documentation

◆ dimension