collection of utility functions for DIY-based KdTree algorithm More...

#include <vtkDIYKdTreeUtilities.h>

Inheritance diagram for vtkDIYKdTreeUtilities:

Collaboration diagram for vtkDIYKdTreeUtilities:

Public Types
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.

vtkDIYKdTreeUtilities *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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.

vtkCommand *	GetCommand (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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

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.

virtual 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.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkDIYKdTreeUtilities *	SafeDownCast (vtkObjectBase *o)

static std::vector< vtkBoundingBox >	GenerateCuts (vtkDataObject dobj, int number_of_partitions, bool use_cell_centers, vtkMultiProcessController controller=nullptr, const double *local_bounds=nullptr)
	Given a dataset (or a composite dataset), this method will generate box cuts in the domain to approximately load balance the points (or cell-centers) into `number_of_partitions` requested.

static std::vector< vtkBoundingBox >	GenerateCuts (const std::vector< vtkDataObject * > &dobjs, int number_of_partitions, bool use_cell_centers, vtkMultiProcessController controller=nullptr, const double local_bounds=nullptr)
	Another variant to GenerateCuts that simply takes in a vector of dataobjects, each can be a dataset or a composite dataset.

static std::vector< vtkBoundingBox >	GenerateCuts (const std::vector< vtkSmartPointer< vtkPoints > > &points, int number_of_partitions, vtkMultiProcessController controller=nullptr, const double local_bounds=nullptr)
	Given a collection of points, this method will generate box cuts in the domain to approximately load balance the points into `number_of_partitions` requested.

static vtkSmartPointer< vtkPartitionedDataSet >	Exchange (vtkPartitionedDataSet parts, vtkMultiProcessController controller, std::shared_ptr< diy::Assigner > block_assigner=nullptr)
	Exchange parts in the partitioned dataset among ranks in the parallel group defined by the `controller`.

static bool	GenerateGlobalCellIds (vtkPartitionedDataSet parts, vtkMultiProcessController controller, vtkIdType *mb_offset=nullptr)
	Generates and adds global cell ids to datasets in `parts`.

static std::vector< int >	ComputeAssignments (int num_blocks, int num_ranks)
	`GenerateCuts` returns a kd-tree with power of 2 nodes.

static vtkDIYExplicitAssigner	CreateAssigner (diy::mpi::communicator &comm, int num_blocks)
	Returns an assigner that assigns power-of-two blocks to an arbitrary number of ranks such that each rank with a non-empty assignment gets a subtree – thus preserving the kd-tree ordering between ranks.

static void	ResizeCuts (std::vector< vtkBoundingBox > &cuts, int size)
	`GenerateCuts` returns a kd-tree with power of 2 nodes.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 (int 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 int	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const

	vtkDIYKdTreeUtilities ()

	~vtkDIYKdTreeUtilities () 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 *)

	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 vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

collection of utility functions for DIY-based KdTree algorithm

vtkDIYKdTreeUtilities is intended for use by vtkRedistributeDataSetFilter. It encapsulates invocation of DIY algorithms for various steps in the vtkRedistributeDataSetFilter.

Definition at line 44 of file vtkDIYKdTreeUtilities.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkDIYKdTreeUtilities::Superclass

Definition at line 47 of file vtkDIYKdTreeUtilities.h.

Constructor & Destructor Documentation

◆ vtkDIYKdTreeUtilities()

vtkDIYKdTreeUtilities::vtkDIYKdTreeUtilities ( )

protected

◆ ~vtkDIYKdTreeUtilities()

vtkDIYKdTreeUtilities::~vtkDIYKdTreeUtilities ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkDIYKdTreeUtilities::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 vtkObjectBase.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDIYKdTreeUtilities::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkDIYKdTreeUtilities * vtkDIYKdTreeUtilities::NewInstance ( ) const

◆ PrintSelf()

void vtkDIYKdTreeUtilities::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ GenerateCuts() [1/3]

static std::vector< vtkBoundingBox > vtkDIYKdTreeUtilities::GenerateCuts	(	vtkDataObject *	dobj,
		int	number_of_partitions,
		bool	use_cell_centers,
		vtkMultiProcessController *	controller = `nullptr`,
		const double *	local_bounds = `nullptr`
	)

static

Given a dataset (or a composite dataset), this method will generate box cuts in the domain to approximately load balance the points (or cell-centers) into number_of_partitions requested.

If controller is non-null, the operation will be performed taking points on the multiple ranks into consideration.

local_bounds provides the local domain bounds. If not specified, domain bounds will be computed using the dobj.

Returns a vector a bounding boxes that can be used to partition the points into load balanced chunks. The size of the vector is greater than or equal to the number_of_partitions.

◆ GenerateCuts() [2/3]

static std::vector< vtkBoundingBox > vtkDIYKdTreeUtilities::GenerateCuts	(	const std::vector< vtkDataObject * > &	dobjs,
		int	number_of_partitions,
		bool	use_cell_centers,
		vtkMultiProcessController *	controller = `nullptr`,
		const double *	local_bounds = `nullptr`
	)

static

Another variant to GenerateCuts that simply takes in a vector of dataobjects, each can be a dataset or a composite dataset.

◆ GenerateCuts() [3/3]

static std::vector< vtkBoundingBox > vtkDIYKdTreeUtilities::GenerateCuts	(	const std::vector< vtkSmartPointer< vtkPoints > > &	points,
		int	number_of_partitions,
		vtkMultiProcessController *	controller = `nullptr`,
		const double *	local_bounds = `nullptr`
	)

static

Given a collection of points, this method will generate box cuts in the domain to approximately load balance the points into number_of_partitions requested.

If controller is non-null, the operation will be performed taking points on the multiple ranks into consideration.

local_bounds provides the local domain bounds. If not specified, domain bounds will be computed using the points provided.

Returns a vector a bounding boxes that can be used to partition the points into load balanced chunks. The size of the vector is greater than or equal to the number_of_partitions.

◆ Exchange()

static vtkSmartPointer< vtkPartitionedDataSet > vtkDIYKdTreeUtilities::Exchange	(	vtkPartitionedDataSet *	parts,
		vtkMultiProcessController *	controller,
		std::shared_ptr< diy::Assigner >	block_assigner = `nullptr`
	)

static

Exchange parts in the partitioned dataset among ranks in the parallel group defined by the controller.

The parts are assigned to ranks in a contiguous fashion.

To determine which partition in the parts is targeted for which ranks, the block_assigner is used, if specified. If not specified, an assigner will be created internally using the following rules. If the number of partitions is a power of two, then vtkDIYKdTreeUtilities::CreateAssigner is used otherwise a diy::ContiguousAssigner is created.

The returned vtkPartitionedDataSet will also have exactly as many partitions as the input vtkPartitionedDataSet, however only the partitions assigned to this current rank may be non-null.

block_assigner is an optional parameter that should be set if the user wants to assign blocks in a custom way. The default assigner is the one returned by vtkDIYKdTreeUtilities::CreateAssigner.

◆ GenerateGlobalCellIds()

static bool vtkDIYKdTreeUtilities::GenerateGlobalCellIds	(	vtkPartitionedDataSet *	parts,
		vtkMultiProcessController *	controller,
		vtkIdType *	mb_offset = `nullptr`
	)

static

Generates and adds global cell ids to datasets in parts.

One this to note that this method does not assign valid global ids to ghost cells. This may not be adequate for general use, however for vtkRedistributeDataSetFilter this is okay since the ghost cells in the input are anyways discarded when the dataset is being split based on the cuts provided. This simplifies the implementation and reduces communication.

◆ ComputeAssignments()

static std::vector< int > vtkDIYKdTreeUtilities::ComputeAssignments	(	int	num_blocks,
		int	num_ranks
	)

static

GenerateCuts returns a kd-tree with power of 2 nodes.

Oftentimes, we want to generate rank assignments for a fewer number of ranks for the nodes such that each rank gets assigned a complete sub-tree. Use this function to generate such an assignment. This has following constraints:

num_blocks must be a power of two.
num_ranks cannot be greater than num_blocks.

◆ CreateAssigner()

static vtkDIYExplicitAssigner vtkDIYKdTreeUtilities::CreateAssigner	(	diy::mpi::communicator &	comm,
		int	num_blocks
	)

static

Returns an assigner that assigns power-of-two blocks to an arbitrary number of ranks such that each rank with a non-empty assignment gets a subtree – thus preserving the kd-tree ordering between ranks.

◆ ResizeCuts()

static void vtkDIYKdTreeUtilities::ResizeCuts	(	std::vector< vtkBoundingBox > &	cuts,
		int	size
	)

static

GenerateCuts returns a kd-tree with power of 2 nodes.

Use this function to resize the cuts to lower number while still preserving the kd-tree. This is done by merging leaf nodes till the requested size is reached. If size is negative or greater than then number of cuts.size(), then this function does nothing. Otherwise when the function returns, cuts.size() == size.

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

Filters/ParallelDIY2/vtkDIYKdTreeUtilities.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkDIYKdTreeUtilities()

◆ ~vtkDIYKdTreeUtilities()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GenerateCuts() [1/3]

◆ GenerateCuts() [2/3]

◆ GenerateCuts() [3/3]

◆ Exchange()

◆ GenerateGlobalCellIds()

◆ ComputeAssignments()

◆ CreateAssigner()

◆ ResizeCuts()