Dumux::GeometriesEntitySet< GeoType > Class Template Reference

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

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

Description

template<class GeoType>
class Dumux::GeometriesEntitySet< GeoType >

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 = Entity::Geometry::coorddimension }
	The world dimension of the entity set. More...
using	Entity = EntityWrapper
using	ctype = typename Entity::Geometry::ctype
	the coordinate type More...

Public Member Functions
	GeometriesEntitySet (std::initializer_list< typename Entity::Geometry > &&geometries)
	Constructor for initializer_list. More...
	GeometriesEntitySet (const std::vector< typename Entity::Geometry > &geometries)
	Constructor for a vector of geometries. More...
	GeometriesEntitySet (std::vector< typename Entity::Geometry > &&geometries)
	Constructor for a vector of geometries. More...
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...
template<class Entity >
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 GeoType >

using Dumux::GeometriesEntitySet< GeoType >::ctype = typename Entity::Geometry::ctype

the coordinate type

Entity

template<class GeoType >

using Dumux::GeometriesEntitySet< GeoType >::Entity = EntityWrapper

Member Enumeration Documentation

anonymous enum

template<class GeoType >

anonymous enum

The world dimension of the entity set.

Enumerator
dimensionworld

Constructor & Destructor Documentation

GeometriesEntitySet() [1/3]

template<class GeoType >

Dumux::GeometriesEntitySet< GeoType >::GeometriesEntitySet ( std::initializer_list< typename Entity::Geometry > &&  geometries )

inline

Constructor for initializer_list.

GeometriesEntitySet() [2/3]

template<class GeoType >

Dumux::GeometriesEntitySet< GeoType >::GeometriesEntitySet ( const std::vector< typename Entity::Geometry > &  geometries )

inline

Constructor for a vector of geometries.

GeometriesEntitySet() [3/3]

template<class GeoType >

Dumux::GeometriesEntitySet< GeoType >::GeometriesEntitySet ( std::vector< typename Entity::Geometry > &&  geometries )

inline

Constructor for a vector of geometries.

Member Function Documentation

begin()

template<class GeoType >

decltype(auto) Dumux::GeometriesEntitySet< GeoType >::begin ( ) const

inline

begin iterator to enable range-based for iteration

end()

template<class GeoType >

decltype(auto) Dumux::GeometriesEntitySet< GeoType >::end ( ) const

inline

end iterator to enable range-based for iteration

entity()

template<class GeoType >

Entity Dumux::GeometriesEntitySet< GeoType >::entity ( std::size_t  index ) const

inline

get an entity from an index

index()

template<class GeoType >

template<class Entity >

std::size_t Dumux::GeometriesEntitySet< GeoType >::index ( const Entity &  e ) const

inline

get an entities index

size()

template<class GeoType >

decltype(auto) Dumux::GeometriesEntitySet< GeoType >::size ( ) const

inline

the number of entities in this set

---

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

• geometricentityset.hh