Encapsulation structure for describing the result of a partitioning calculation. More...

#include <vtkPartitioningStrategy.h>

Collaboration diagram for vtkPartitioningStrategy::PartitionInformation:

Public Attributes
PartitionedEntity	TargetEntity = CELLS
	Principal entity on which the partitioning is defined.

vtkNew< vtkIdTypeArray >	TargetPartitions
	An array defining on which rank each currently local principal entity should be shipped to.

vtkNew< vtkIdTypeArray >	BoundaryNeighborPartitions
	A 2 component array defining boundary entity indexes and their neighbor partition index.

vtkIdType	NumberOfPartitions = 0
	The total number of partitions.

Detailed Description

Encapsulation structure for describing the result of a partitioning calculation.

This structures defines a format for transmitting partition information from the partitioning algorithm to the communication and dispatching phase of the vtkRedistributeDataSetFilter. Its elements are:

TargetEntity: an enum signaling which principal entities are being partitioned by the partitioning algorithm
TargetPartitions: the main structure containing the partitioning information result of the algorithm
BoundaryNeighborPartitions: an array of pairs augmenting the TargetPartitions information with partition boundary information
NumberOfPartitions: the total number of partitions for the data set

The TargetPartitions array is an array with as many tuples as there are entities in the data set and only 1 component. Its value denotes the rank which owns a given entity in the calculated partition. For example, if no redistribution is required, than the TargetPartitions array has constant value equal to the local process rank. The BoundaryNeighborPartitions is an array with as many tuples as there are entities at the boundaries of the new partitions locally and 2 components. Each tuple is thus an (entity index, process index) pair describing whether a given entity lies adjacent to a partition boundary and therefore might be included in some ghost information during communication and dispatching.

Definition at line 75 of file vtkPartitioningStrategy.h.

Member Data Documentation

◆ TargetEntity

PartitionedEntity vtkPartitioningStrategy::PartitionInformation::TargetEntity = CELLS

Principal entity on which the partitioning is defined.

Definition at line 81 of file vtkPartitioningStrategy.h.

◆ TargetPartitions

vtkNew<vtkIdTypeArray> vtkPartitioningStrategy::PartitionInformation::TargetPartitions

An array defining on which rank each currently local principal entity should be shipped to.

Definition at line 85 of file vtkPartitioningStrategy.h.

◆ BoundaryNeighborPartitions

vtkNew<vtkIdTypeArray> vtkPartitioningStrategy::PartitionInformation::BoundaryNeighborPartitions

A 2 component array defining boundary entity indexes and their neighbor partition index.

Definition at line 89 of file vtkPartitioningStrategy.h.

◆ NumberOfPartitions

vtkIdType vtkPartitioningStrategy::PartitionInformation::NumberOfPartitions = 0

The total number of partitions.

Definition at line 93 of file vtkPartitioningStrategy.h.

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