VTK  9.4.20250202
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkNativePartitioningStrategy Class Referencefinal

A partitioning strategy based on load balancing geometric bounding boxes as cuts of a data set. More...

#include <vtkNativePartitioningStrategy.h>

Inheritance diagram for vtkNativePartitioningStrategy:
[legend]
Collaboration diagram for vtkNativePartitioningStrategy:
[legend]

Public Types

typedef vtkPartitioningStrategy Superclass
 
- Public Types inherited from vtkPartitioningStrategy
enum  PartitionedEntity { POINTS = 0 , CELLS = 1 }
 An enum defining which principal entity is being partitioned. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkNativePartitioningStrategyNewInstance () const
 
void PrintSelf (std::ostream &os, vtkIndent indent) override
 
std::vector< PartitionInformationComputePartition (vtkPartitionedDataSetCollection *) override
 Implementation of parent API.
 
std::vector< vtkBoundingBoxExpandCuts (const std::vector< vtkBoundingBox > &cuts, const vtkBoundingBox &bounds)
 Helper function to expand a collection of bounding boxes to include the bounds specified.
 
virtual std::vector< vtkBoundingBoxGenerateCuts (vtkDataObject *data)
 This method is called to generate the partitions for the input dataset.
 
virtual void SetUseExplicitCuts (bool)
 Specify whether to compute the load balancing automatically or use explicitly provided cuts.
 
virtual bool GetUseExplicitCuts ()
 Specify whether to compute the load balancing automatically or use explicitly provided cuts.
 
virtual void UseExplicitCutsOn ()
 Specify whether to compute the load balancing automatically or use explicitly provided cuts.
 
virtual void UseExplicitCutsOff ()
 Specify whether to compute the load balancing automatically or use explicitly provided cuts.
 
void SetExplicitCuts (const std::vector< vtkBoundingBox > &boxes)
 Specify the cuts to use when UseExplicitCuts is true.
 
const std::vector< vtkBoundingBox > & GetExplicitCuts () const
 Specify the cuts to use when UseExplicitCuts is true.
 
void RemoveAllExplicitCuts ()
 Specify the cuts to use when UseExplicitCuts is true.
 
void AddExplicitCut (const vtkBoundingBox &bbox)
 Specify the cuts to use when UseExplicitCuts is true.
 
void AddExplicitCut (const double bbox[6])
 Specify the cuts to use when UseExplicitCuts is true.
 
int GetNumberOfExplicitCuts () const
 Specify the cuts to use when UseExplicitCuts is true.
 
const vtkBoundingBoxGetExplicitCut (int index) const
 Specify the cuts to use when UseExplicitCuts is true.
 
virtual void SetExpandExplicitCuts (bool)
 When using explicit cuts, it possible that the bounding box defined by all the cuts is smaller than the input's bounds.
 
virtual bool GetExpandExplicitCuts ()
 When using explicit cuts, it possible that the bounding box defined by all the cuts is smaller than the input's bounds.
 
virtual void ExpandExplicitCutsOn ()
 When using explicit cuts, it possible that the bounding box defined by all the cuts is smaller than the input's bounds.
 
virtual void ExpandExplicitCutsOff ()
 When using explicit cuts, it possible that the bounding box defined by all the cuts is smaller than the input's bounds.
 
const std::vector< vtkBoundingBox > & GetCuts () const
 Returns the cuts used by the most recent ComputePartition call.
 
virtual void SetLoadBalanceAcrossAllBlocks (bool)
 When UseExplicitCuts is false, and input is a vtkPartitionedDataSetCollection, set this to true to generate cuts for load balancing using all the datasets in the vtkPartitionedDataSetCollection.
 
virtual bool GetLoadBalanceAcrossAllBlocks ()
 When UseExplicitCuts is false, and input is a vtkPartitionedDataSetCollection, set this to true to generate cuts for load balancing using all the datasets in the vtkPartitionedDataSetCollection.
 
virtual void LoadBalanceAcrossAllBlocksOn ()
 When UseExplicitCuts is false, and input is a vtkPartitionedDataSetCollection, set this to true to generate cuts for load balancing using all the datasets in the vtkPartitionedDataSetCollection.
 
virtual void LoadBalanceAcrossAllBlocksOff ()
 When UseExplicitCuts is false, and input is a vtkPartitionedDataSetCollection, set this to true to generate cuts for load balancing using all the datasets in the vtkPartitionedDataSetCollection.
 
- Public Member Functions inherited from vtkPartitioningStrategy
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkPartitioningStrategyNewInstance () const
 
void PrintSelf (std::ostream &os, vtkIndent indent) override
 
virtual std::vector< PartitionInformationComputePartition (vtkPartitionedDataSetCollection *)=0
 Main method for subclasses to implement in order to define their partitioning method (should be called on all ranks due to distributed communication)
 
void SetController (vtkMultiProcessController *)
 Get/Set the controller to use.
 
virtual vtkMultiProcessControllerGetController ()
 Get/Set the controller to use.
 
virtual vtkIdType GetNumberOfPartitions ()
 Get/Set number of partitions (if < 0 use number of MPI ranks)
 
virtual void SetNumberOfPartitions (vtkIdType)
 Get/Set number of partitions (if < 0 use number of MPI ranks)
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkNativePartitioningStrategyNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkNativePartitioningStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPartitioningStrategy
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPartitioningStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkNativePartitioningStrategy ()=default
 
 ~vtkNativePartitioningStrategy () override=default
 
- Protected Member Functions inherited from vtkPartitioningStrategy
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPartitioningStrategy ()
 
 ~vtkPartitioningStrategy () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkPartitioningStrategy
vtkMultiProcessControllerController = nullptr
 
vtkIdType NumberOfPartitions = -1
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

A partitioning strategy based on load balancing geometric bounding boxes as cuts of a data set.

This strategy is the traditional strategy used in the vtkRedistributeDataSetFilter which has been refactored into this class. It is based on cuting up the data set into equally balanced (in terms of cell number) bounding boxes that then get distributed to all ranks.

The load balancing attempts to balance the number of cells per target partition approximately. It uses a DIY-based kdtree implementation that balances the cell centers among requested number of partitions. Current implementation only supports power-of-2 target partition. If a non-power of two value is specified for NumberOfPartitions, then the load balancing simply uses the power-of-two greater than the requested value. The bounding boxes for the kdtree leaf nodes are then used to redistribute the data.

Alternatively a collection of bounding boxes may be provided that can be used to distribute the data instead of computing them (see UseExplicitCuts and SetExplicitCuts). When explicit cuts are specified, it is possible use those cuts strictly or to expand boxes on the edge to fit the domain of the input dataset. This can be controlled by ExpandExplicitCutsForInputDomain.

Definition at line 36 of file vtkNativePartitioningStrategy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkNativePartitioningStrategy.h.

Constructor & Destructor Documentation

◆ vtkNativePartitioningStrategy()

vtkNativePartitioningStrategy::vtkNativePartitioningStrategy ( )
protecteddefault

◆ ~vtkNativePartitioningStrategy()

vtkNativePartitioningStrategy::~vtkNativePartitioningStrategy ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkNativePartitioningStrategy * vtkNativePartitioningStrategy::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkNativePartitioningStrategy::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkNativePartitioningStrategy::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPartitioningStrategy.

◆ SafeDownCast()

static vtkNativePartitioningStrategy * vtkNativePartitioningStrategy::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkNativePartitioningStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPartitioningStrategy.

◆ NewInstance()

vtkNativePartitioningStrategy * vtkNativePartitioningStrategy::NewInstance ( ) const

◆ PrintSelf()

void vtkNativePartitioningStrategy::PrintSelf ( std::ostream &  os,
vtkIndent  indent 
)
override

◆ ComputePartition()

std::vector< PartitionInformation > vtkNativePartitioningStrategy::ComputePartition ( vtkPartitionedDataSetCollection )
overridevirtual

Implementation of parent API.

Implements vtkPartitioningStrategy.

◆ SetUseExplicitCuts()

virtual void vtkNativePartitioningStrategy::SetUseExplicitCuts ( bool  )
virtual

Specify whether to compute the load balancing automatically or use explicitly provided cuts.

Set to false (default) to automatically compute the cuts to use for redistributing the dataset.

◆ GetUseExplicitCuts()

virtual bool vtkNativePartitioningStrategy::GetUseExplicitCuts ( )
virtual

Specify whether to compute the load balancing automatically or use explicitly provided cuts.

Set to false (default) to automatically compute the cuts to use for redistributing the dataset.

◆ UseExplicitCutsOn()

virtual void vtkNativePartitioningStrategy::UseExplicitCutsOn ( )
virtual

Specify whether to compute the load balancing automatically or use explicitly provided cuts.

Set to false (default) to automatically compute the cuts to use for redistributing the dataset.

◆ UseExplicitCutsOff()

virtual void vtkNativePartitioningStrategy::UseExplicitCutsOff ( )
virtual

Specify whether to compute the load balancing automatically or use explicitly provided cuts.

Set to false (default) to automatically compute the cuts to use for redistributing the dataset.

◆ SetExplicitCuts()

void vtkNativePartitioningStrategy::SetExplicitCuts ( const std::vector< vtkBoundingBox > &  boxes)

Specify the cuts to use when UseExplicitCuts is true.

◆ GetExplicitCuts()

const std::vector< vtkBoundingBox > & vtkNativePartitioningStrategy::GetExplicitCuts ( ) const
inline

Specify the cuts to use when UseExplicitCuts is true.

Definition at line 65 of file vtkNativePartitioningStrategy.h.

◆ RemoveAllExplicitCuts()

void vtkNativePartitioningStrategy::RemoveAllExplicitCuts ( )

Specify the cuts to use when UseExplicitCuts is true.

◆ AddExplicitCut() [1/2]

void vtkNativePartitioningStrategy::AddExplicitCut ( const vtkBoundingBox bbox)

Specify the cuts to use when UseExplicitCuts is true.

◆ AddExplicitCut() [2/2]

void vtkNativePartitioningStrategy::AddExplicitCut ( const double  bbox[6])

Specify the cuts to use when UseExplicitCuts is true.

◆ GetNumberOfExplicitCuts()

int vtkNativePartitioningStrategy::GetNumberOfExplicitCuts ( ) const

Specify the cuts to use when UseExplicitCuts is true.

◆ GetExplicitCut()

const vtkBoundingBox & vtkNativePartitioningStrategy::GetExplicitCut ( int  index) const

Specify the cuts to use when UseExplicitCuts is true.

◆ SetExpandExplicitCuts()

virtual void vtkNativePartitioningStrategy::SetExpandExplicitCuts ( bool  )
virtual

When using explicit cuts, it possible that the bounding box defined by all the cuts is smaller than the input's bounds.

In that case, the filter can automatically expand the edge boxes to include the input bounds to avoid clipping of the input dataset on the external faces of the combined bounding box.

Default is true, that is explicit cuts will automatically be expanded.

◆ GetExpandExplicitCuts()

virtual bool vtkNativePartitioningStrategy::GetExpandExplicitCuts ( )
virtual

When using explicit cuts, it possible that the bounding box defined by all the cuts is smaller than the input's bounds.

In that case, the filter can automatically expand the edge boxes to include the input bounds to avoid clipping of the input dataset on the external faces of the combined bounding box.

Default is true, that is explicit cuts will automatically be expanded.

◆ ExpandExplicitCutsOn()

virtual void vtkNativePartitioningStrategy::ExpandExplicitCutsOn ( )
virtual

When using explicit cuts, it possible that the bounding box defined by all the cuts is smaller than the input's bounds.

In that case, the filter can automatically expand the edge boxes to include the input bounds to avoid clipping of the input dataset on the external faces of the combined bounding box.

Default is true, that is explicit cuts will automatically be expanded.

◆ ExpandExplicitCutsOff()

virtual void vtkNativePartitioningStrategy::ExpandExplicitCutsOff ( )
virtual

When using explicit cuts, it possible that the bounding box defined by all the cuts is smaller than the input's bounds.

In that case, the filter can automatically expand the edge boxes to include the input bounds to avoid clipping of the input dataset on the external faces of the combined bounding box.

Default is true, that is explicit cuts will automatically be expanded.

◆ ExpandCuts()

std::vector< vtkBoundingBox > vtkNativePartitioningStrategy::ExpandCuts ( const std::vector< vtkBoundingBox > &  cuts,
const vtkBoundingBox bounds 
)

Helper function to expand a collection of bounding boxes to include the bounds specified.

This will expand any boxes in the cuts that abut any of the external faces of the bounding box formed by all the cuts to touch the external faces of the bounds.

◆ GetCuts()

const std::vector< vtkBoundingBox > & vtkNativePartitioningStrategy::GetCuts ( ) const
inline

Returns the cuts used by the most recent ComputePartition call.

This is only valid after a successful ComputePartition request.

Definition at line 103 of file vtkNativePartitioningStrategy.h.

◆ SetLoadBalanceAcrossAllBlocks()

virtual void vtkNativePartitioningStrategy::SetLoadBalanceAcrossAllBlocks ( bool  )
virtual

When UseExplicitCuts is false, and input is a vtkPartitionedDataSetCollection, set this to true to generate cuts for load balancing using all the datasets in the vtkPartitionedDataSetCollection.

Default is true.

◆ GetLoadBalanceAcrossAllBlocks()

virtual bool vtkNativePartitioningStrategy::GetLoadBalanceAcrossAllBlocks ( )
virtual

When UseExplicitCuts is false, and input is a vtkPartitionedDataSetCollection, set this to true to generate cuts for load balancing using all the datasets in the vtkPartitionedDataSetCollection.

Default is true.

◆ LoadBalanceAcrossAllBlocksOn()

virtual void vtkNativePartitioningStrategy::LoadBalanceAcrossAllBlocksOn ( )
virtual

When UseExplicitCuts is false, and input is a vtkPartitionedDataSetCollection, set this to true to generate cuts for load balancing using all the datasets in the vtkPartitionedDataSetCollection.

Default is true.

◆ LoadBalanceAcrossAllBlocksOff()

virtual void vtkNativePartitioningStrategy::LoadBalanceAcrossAllBlocksOff ( )
virtual

When UseExplicitCuts is false, and input is a vtkPartitionedDataSetCollection, set this to true to generate cuts for load balancing using all the datasets in the vtkPartitionedDataSetCollection.

Default is true.

◆ GenerateCuts()

virtual std::vector< vtkBoundingBox > vtkNativePartitioningStrategy::GenerateCuts ( vtkDataObject data)
virtual

This method is called to generate the partitions for the input dataset.

Subclasses should override this to generate partitions using preferred data redistribution strategy.

The data will either be a vtkPartitionedDataSet or a vtkDataSet. In case of vtkPartitionedDataSet, the method is expected to redistribute all datasets (partitions) in the vtkPartitionedDataSet taken as a whole.


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