Dumux::GridViewGeometricEntitySet< GridView, codim, Mapper > Class Template Reference

An interface for a set of geometric entities. More...

#include <dumux/common/geometry/geometricentityset.hh>

Description

template<class GridView, int codim = 0, class Mapper = Dune::MultipleCodimMultipleGeomTypeMapper<GridView>>
class Dumux::GridViewGeometricEntitySet< GridView, codim, Mapper >

An interface for a set of geometric entities.

Note

This can be used e.g. to contruct a bounding box volume hierarchy of a grid It defines the minimum requirement for such a set

Public Types
enum	{ dimensionworld = GridView::dimensionworld }
	The world dimension of the entity set. More...
using	Entity = typename GridView::template Codim< codim >::Entity
using	ctype = typename GridView::ctype
	the coordinate type More...

Public Member Functions
	GridViewGeometricEntitySet (const GridView &gridView)
	GridViewGeometricEntitySet (const GridView &gridView, const Mapper &mapper)
	GridViewGeometricEntitySet (const GridView &gridView, const Mapper &mapper, std::shared_ptr< const EntityMap > entityMap)
decltype(auto)	size () const
	the number of entities in this set More...
decltype(auto)	begin () const
	begin iterator to enable range-based for iteration More...
decltype(auto)	end () const
	end iterator to enable range-based for iteration More...
std::size_t	index (const Entity &e) const
	get an entities index More...
Entity	entity (std::size_t index) const
	get an entity from an index More...

Member Typedef Documentation

ctype

template<class GridView , int codim = 0, class Mapper = Dune::MultipleCodimMultipleGeomTypeMapper<GridView>>

using Dumux::GridViewGeometricEntitySet< GridView, codim, Mapper >::ctype = typename GridView::ctype

the coordinate type

Entity

template<class GridView , int codim = 0, class Mapper = Dune::MultipleCodimMultipleGeomTypeMapper<GridView>>

using Dumux::GridViewGeometricEntitySet< GridView, codim, Mapper >::Entity = typename GridView::template Codim<codim>::Entity

Member Enumeration Documentation

anonymous enum

template<class GridView , int codim = 0, class Mapper = Dune::MultipleCodimMultipleGeomTypeMapper<GridView>>

anonymous enum

The world dimension of the entity set.

Enumerator
dimensionworld

Constructor & Destructor Documentation

GridViewGeometricEntitySet() [1/3]

template<class GridView , int codim = 0, class Mapper = Dune::MultipleCodimMultipleGeomTypeMapper<GridView>>

Dumux::GridViewGeometricEntitySet< GridView, codim, Mapper >::GridViewGeometricEntitySet ( const GridView &  gridView )

inline

GridViewGeometricEntitySet() [2/3]

template<class GridView , int codim = 0, class Mapper = Dune::MultipleCodimMultipleGeomTypeMapper<GridView>>

Dumux::GridViewGeometricEntitySet< GridView, codim, Mapper >::GridViewGeometricEntitySet ( const GridView &  gridView, const Mapper &  mapper  )

inline

GridViewGeometricEntitySet() [3/3]

template<class GridView , int codim = 0, class Mapper = Dune::MultipleCodimMultipleGeomTypeMapper<GridView>>

Dumux::GridViewGeometricEntitySet< GridView, codim, Mapper >::GridViewGeometricEntitySet ( const GridView &  gridView, const Mapper &  mapper, std::shared_ptr< const EntityMap >  entityMap  )

inline

Member Function Documentation

begin()

template<class GridView , int codim = 0, class Mapper = Dune::MultipleCodimMultipleGeomTypeMapper<GridView>>

decltype(auto) Dumux::GridViewGeometricEntitySet< GridView, codim, Mapper >::begin ( ) const

inline

begin iterator to enable range-based for iteration

end()

template<class GridView , int codim = 0, class Mapper = Dune::MultipleCodimMultipleGeomTypeMapper<GridView>>

decltype(auto) Dumux::GridViewGeometricEntitySet< GridView, codim, Mapper >::end ( ) const

inline

end iterator to enable range-based for iteration

entity()

template<class GridView , int codim = 0, class Mapper = Dune::MultipleCodimMultipleGeomTypeMapper<GridView>>

Entity Dumux::GridViewGeometricEntitySet< GridView, codim, Mapper >::entity ( std::size_t  index ) const

inline

get an entity from an index

index()

template<class GridView , int codim = 0, class Mapper = Dune::MultipleCodimMultipleGeomTypeMapper<GridView>>

std::size_t Dumux::GridViewGeometricEntitySet< GridView, codim, Mapper >::index ( const Entity &  e ) const

inline

get an entities index

size()

template<class GridView , int codim = 0, class Mapper = Dune::MultipleCodimMultipleGeomTypeMapper<GridView>>

decltype(auto) Dumux::GridViewGeometricEntitySet< GridView, codim, Mapper >::size ( ) const

inline

the number of entities in this set

---

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

• geometricentityset.hh