exchange data-object among ranks. More...

#include <vtkDIYDataExchanger.h>

Inheritance diagram for vtkDIYDataExchanger:

Collaboration diagram for vtkDIYDataExchanger:

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

vtkDIYDataExchanger *	NewInstance () const

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

bool	AllToAll (const std::vector< vtkSmartPointer< vtkDataSet > > &sendBuffer, const std::vector< int > &sendCounts, std::vector< vtkSmartPointer< vtkDataSet > > &recvBuffer, std::vector< int > &recvCounts)
	Exchange data between all ranks in the process group defined by the `Controller`. More...


void	SetController (vtkMultiProcessController *)
	Get/Set the controller to use. More...

virtual vtkMultiProcessController *	GetController ()
	Get/Set the controller to use. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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

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

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

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

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

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

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

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

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

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). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

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

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

Static Public Member Functions
static vtkDIYDataExchanger *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDIYDataExchanger *	SafeDownCast (vtkObjectBase *o)

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

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

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). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDIYDataExchanger ()

	~vtkDIYDataExchanger () 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. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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

exchange data-object among ranks.

vtkDIYDataExchanger is a utility to exchange data-objects across multiple ranks. The design is based on MPI_Alltoall enabling algorithms to exchange data-objects between each other. The implementation uses DIY.

Note, current implementation only supports exchanging vtkDataSet and subclasses. That may change in the future.

Definition at line 39 of file vtkDIYDataExchanger.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkDIYDataExchanger::Superclass

Definition at line 43 of file vtkDIYDataExchanger.h.

Constructor & Destructor Documentation

◆ vtkDIYDataExchanger()

vtkDIYDataExchanger::vtkDIYDataExchanger ( )

protected

◆ ~vtkDIYDataExchanger()

vtkDIYDataExchanger::~vtkDIYDataExchanger ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkDIYDataExchanger * vtkDIYDataExchanger::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkDIYDataExchanger::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 vtkDIYDataExchanger * vtkDIYDataExchanger::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDIYDataExchanger::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkDIYDataExchanger * vtkDIYDataExchanger::NewInstance ( ) const

◆ PrintSelf()

void vtkDIYDataExchanger::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.

◆ SetController()

void vtkDIYDataExchanger::SetController ( vtkMultiProcessController * )

Get/Set the controller to use.

By default vtkMultiProcessController::GetGlobalController is used.

◆ GetController()

virtual vtkMultiProcessController * vtkDIYDataExchanger::GetController ( )

virtual

Get/Set the controller to use.

By default vtkMultiProcessController::GetGlobalController is used.

◆ AllToAll()

bool vtkDIYDataExchanger::AllToAll	(	const std::vector< vtkSmartPointer< vtkDataSet > > &	sendBuffer,
		const std::vector< int > &	sendCounts,
		std::vector< vtkSmartPointer< vtkDataSet > > &	recvBuffer,
		std::vector< int > &	recvCounts
	)

Exchange data between all ranks in the process group defined by the Controller.

Every rank builds a vector of datasets to send to other ranks. This is sendBuffer. sendCounts lets the current rank specify which dataset is targeted for which rank. For example, if an MPI group has 3 ranks and the current process wants to send 2 datasets to rank 0, none to rank 1, and 3 datasets to rank 2, then the sendBuffer should be filled with 5 (2 + 3) datasets and sendCounts should be of size 3 filled with [2, 0, 3]. The first 2 datasets in sendBuffer will be sent to rank 0 while the following 3 datasets will be send to rank 2.

This is a collective operation which must be called on all ranks in the MPI group irrespective of whether any rank is sending or receiving data.

The recvBuffer is filled with datasets received from other ranks. recvCounts is similar to sendCounts in that it helps determine how many datasets were received from each rank and their offset in the recvBuffer.

Parameters

[in]	sendBuffer	collection of datasets to exchange
[in]	sendCounts	array of counts for number of datasets to send to each rank.
[out]	recvBuffer	datasets received from other ranks
[out]	recvCounts	array of counts for number of datasets received from each rank.

Returns: true on success, else false

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

Parallel/DIY/vtkDIYDataExchanger.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

◆ vtkDIYDataExchanger()

◆ ~vtkDIYDataExchanger()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetController()

◆ GetController()

◆ AllToAll()