vtkBlockDistribution Class Reference

#include <vtkBlockDistribution.h>

Detailed Description

A helper class that manages a block distribution of N elements of data.

Definition at line 30 of file vtkBlockDistribution.h.


Public Member Functions
	vtkBlockDistribution (vtkIdType N, vtkIdType P)
vtkIdType	GetNumElements ()
vtkIdType	GetNumProcessors ()
vtkIdType	GetBlockSize (vtkIdType rank)
vtkIdType	GetProcessorOfElement (vtkIdType globalIndex)
vtkIdType	GetLocalIndexOfElement (vtkIdType globalIndex)
vtkIdType	GetFirstGlobalIndexOnProcessor (vtkIdType rank)
vtkIdType	GetGlobalIndex (vtkIdType localIndex, vtkIdType rank)

vtkBlockDistribution::vtkBlockDistribution	(	vtkIdType	N,
		vtkIdType	P
	)			`[inline]`

Create a block distribution with N elements on P processors.

Definition at line 71 of file vtkBlockDistribution.h.

vtkIdType vtkBlockDistribution::GetNumElements ( ) [inline]

Retrieves the number of elements for which this block distribution was built.

Definition at line 38 of file vtkBlockDistribution.h.

vtkIdType vtkBlockDistribution::GetNumProcessors ( ) [inline]

Retrieves the number of processors for which this block distribution was built.

Definition at line 42 of file vtkBlockDistribution.h.

vtkIdType vtkBlockDistribution::GetBlockSize ( vtkIdType rank ) [inline]

Get the block size for the processor with the given rank. This is the number of elements that the processor will store.

Definition at line 78 of file vtkBlockDistribution.h.

vtkIdType vtkBlockDistribution::GetProcessorOfElement ( vtkIdType globalIndex ) [inline]

Retrieve the process number in [0, GetNumProcessors()) where the element with the given global index will be located.

Definition at line 87 of file vtkBlockDistribution.h.

vtkIdType vtkBlockDistribution::GetLocalIndexOfElement ( vtkIdType globalIndex ) [inline]

Retrieve the local index (offset) on the processor determined by GetProcessorOfElement that refers to the given global index.

Definition at line 106 of file vtkBlockDistribution.h.

vtkIdType vtkBlockDistribution::GetFirstGlobalIndexOnProcessor ( vtkIdType rank ) [inline]

Retrieve the first global index stored on the processor with the given rank.

Definition at line 115 of file vtkBlockDistribution.h.

vtkIdType vtkBlockDistribution::GetGlobalIndex	(	vtkIdType	localIndex,
		vtkIdType	rank
	)			`[inline]`

Retrieve the global index associated with the given local index on the processor with the given rank.

Definition at line 132 of file vtkBlockDistribution.h.

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