Defines how the different levels of a grid shall be distributed across the available processes. More...

#include <process_hierarchy.h>

Classes
struct	HLevelInfo

Public Member Functions
void	add_hierarchy_level (size_t gridLvl, size_t numProcsPerProc)

void	add_partition_hint (int hlvl, const std::string &name, const Variant &value)
	allows specification of partitioning hints per hierarchy level. More...

const std::vector< int > &	cluster_procs (size_t hierarchyLevel) const

bool	empty () const

pcl::ProcessCommunicator	global_proc_com (size_t hierarchyLevel) const

size_t	grid_base_level (size_t hierarchyLevel) const

size_t	hierarchy_level_from_grid_level (size_t gridLevel) const

size_t	num_global_procs_involved (size_t hierarchyLevel) const

size_t	num_hierarchy_levels () const

bool	partition_hint (Variant &valOut, int hlvl, const std::string &name) const
	returns true if the queried partition hint exists and writes it value to 'valOut' More...

std::string	to_string () const
	Returns a string which describes the hierarchy layout. More...

	~ProcessHierarchy ()

Static Public Member Functions
static SPProcessHierarchy	create ()

Protected Types
typedef std::map< std::string, Variant >	PartitionHintMap

Protected Member Functions
HLevelInfo &	get_hlevel_info (size_t lvl)

const HLevelInfo &	get_hlevel_info (size_t lvl) const

void	init_cluster_procs (std::vector< int > &clusterProcs, size_t hlvl, size_t numProcsPerProc)

Private Attributes
std::vector< HLevelInfo >	m_levels

Detailed Description

Defines how the different levels of a grid shall be distributed across the available processes.

Used by LoadBalancer and by different partitioners.

Member Typedef Documentation

◆ PartitionHintMap

typedef std::map<std::string, Variant> ug::ProcessHierarchy::PartitionHintMap

protected

Constructor & Destructor Documentation

◆ ~ProcessHierarchy()

ug::ProcessHierarchy::~ProcessHierarchy ( )

Member Function Documentation

◆ add_hierarchy_level()

void ug::ProcessHierarchy::add_hierarchy_level	(	size_t	gridLvl,
		size_t	numProcsPerProc
	)

References ug::ProcessHierarchy::HLevelInfo::clusterProcs, pcl::ProcessCommunicator::create_communicator(), ug::ProcessHierarchy::HLevelInfo::globalCom, ug::ProcessHierarchy::HLevelInfo::gridLvl, ug::ProcessHierarchy::HLevelInfo::numGlobalProcsInUse, and UG_THROW.

◆ add_partition_hint()

void ug::ProcessHierarchy::add_partition_hint	(	int	hlvl,
		const std::string &	name,
		const Variant &	value
	)

allows specification of partitioning hints per hierarchy level.

Note: A hint is valid for all subsequent hierarchy levels until it is specified again with a different value.; Partitioners are free to ignore any partitioning hints. For a list of supported hints please check the documentation of the respective partitioner.

References name, ug::Variant::to_bool(), and UG_LOG.

◆ cluster_procs()

const std::vector< int > & ug::ProcessHierarchy::cluster_procs ( size_t hierarchyLevel ) const

Contains only processes which are contained in the cluster of the given hierarchyLevel in which the local process is included.

Referenced by ug::Partitioner_DynamicBisection< TElem, dim >::partition().

◆ create()

static SPProcessHierarchy ug::ProcessHierarchy::create ( )

inlinestatic

Referenced by ug::CreateProcessHierarchy(), and ug::LoadBalancer::LoadBalancer().

◆ empty()

bool ug::ProcessHierarchy::empty ( ) const

◆ get_hlevel_info() [1/2]

HLevelInfo& ug::ProcessHierarchy::get_hlevel_info ( size_t lvl )

inlineprotected

References m_levels.

◆ get_hlevel_info() [2/2]

const HLevelInfo& ug::ProcessHierarchy::get_hlevel_info ( size_t lvl ) const

inlineprotected

References m_levels.

◆ global_proc_com()

pcl::ProcessCommunicator ug::ProcessHierarchy::global_proc_com ( size_t hierarchyLevel ) const

Contains all processes which participate on the given hierarchy level, but only if the local process participates itself. If it doesn't, the returned communicator is empty.

Referenced by ug::LoadBalancer::estimate_distribution_quality_impl(), and ug::Partitioner_DynamicBisection< TElem, dim >::partition().