Dumux::ProcessGeometricEntitySet< ct, dimworld > Class Template Reference

A set of axis-aligned bounding boxes each owned by a process rank. More...

#include <dumux/geometry/geometricentityset.hh>

Inheritance diagram for Dumux::ProcessGeometricEntitySet< ct, dimworld >:

Description

template<class ct, int dimworld>
class Dumux::ProcessGeometricEntitySet< ct, dimworld >

Used as the entity set of the replicated "process tree" of a Dumux::DistributedBoundingBoxTree: each entity is the partition bounding box of a process and carries the owning rank, so that the index-to-rank mapping lives with the entity set itself.

Public Types
using	Entity = Detail::GeometricEntity::ProcessEntity<ct, dimworld>
using	ctype = ct
	the coordinate type

Public Member Functions
	ProcessGeometricEntitySet (std::vector< Entity > &&entities)
	Constructor from a vector of process partition entities.
std::size_t	size () const
	the number of entities in this set
decltype(auto)	begin () const
	begin iterator to enable range-based for iteration
decltype(auto)	end () const
	end iterator to enable range-based for iteration
std::size_t	index (const Entity &e) const
	get an entities index
const Entity &	entity (std::size_t index) const
	get an entity from an index
int	rank (std::size_t index) const
	get the rank owning the entity with the given index

Static Public Attributes
static constexpr int	dimensionworld = dimworld
	The world dimension of the entity set.

Member Typedef Documentation

ctype

template<class ct, int dimworld>

using Dumux::ProcessGeometricEntitySet< ct, dimworld >::ctype = ct

Entity

template<class ct, int dimworld>

using Dumux::ProcessGeometricEntitySet< ct, dimworld >::Entity = Detail::GeometricEntity::ProcessEntity<ct, dimworld>

Constructor & Destructor Documentation

ProcessGeometricEntitySet()

template<class ct, int dimworld>

Dumux::ProcessGeometricEntitySet< ct, dimworld >::ProcessGeometricEntitySet ( std::vector< Entity > && entities )

inlineexplicit

Member Function Documentation

begin()

template<class ct, int dimworld>

decltype(auto) Dumux::ProcessGeometricEntitySet< ct, dimworld >::begin ( ) const

inline

end()

template<class ct, int dimworld>

decltype(auto) Dumux::ProcessGeometricEntitySet< ct, dimworld >::end ( ) const

inline

entity()

template<class ct, int dimworld>

const Entity & Dumux::ProcessGeometricEntitySet< ct, dimworld >::entity ( std::size_t index ) const

inline

index()

template<class ct, int dimworld>

std::size_t Dumux::ProcessGeometricEntitySet< ct, dimworld >::index ( const Entity & e ) const

inline

rank()

template<class ct, int dimworld>

int Dumux::ProcessGeometricEntitySet< ct, dimworld >::rank ( std::size_t index ) const

inline

size()

template<class ct, int dimworld>

std::size_t Dumux::ProcessGeometricEntitySet< ct, dimworld >::size ( ) const

inline

Member Data Documentation

dimensionworld

template<class ct, int dimworld>

int Dumux::ProcessGeometricEntitySet< ct, dimworld >::dimensionworld = dimworld

staticconstexpr

---

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

• geometricentityset.hh