Class for creating user defined MPI communicators. More...

#include <vtkMPICommunicator.h>

Inheritance diagram for vtkMPICommunicator:

Collaboration diagram for vtkMPICommunicator:

Classes
class	Request

Public Types
typedef vtkCommunicator	Superclass

Public Types inherited from vtkCommunicator
enum	Tags { BROADCAST_TAG = 10 , GATHER_TAG = 11 , GATHERV_TAG = 12 , SCATTER_TAG = 13 , SCATTERV_TAG = 14 , REDUCE_TAG = 15 , BARRIER_TAG = 16 }

enum	StandardOperations { MAX_OP , MIN_OP , SUM_OP , PRODUCT_OP , LOGICAL_AND_OP , BITWISE_AND_OP , LOGICAL_OR_OP , BITWISE_OR_OP , LOGICAL_XOR_OP , BITWISE_XOR_OP }

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.

vtkMPICommunicator *	NewInstance () const

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

int	Initialize (vtkProcessGroup *group)
	Used to initialize the communicator (i.e.

int	SplitInitialize (vtkCommunicator *oldcomm, int color, int key)
	Used to initialize the communicator (i.e.

int	WaitAll (const int count, Request requests[])
	Given the request objects of a set of non-blocking operations (send and/or receive) this method blocks until all requests are complete.

int	WaitAny (const int count, Request requests[], int &idx)
	Blocks until one of the specified requests in the given request array completes.

int	WaitSome (const int count, Request requests[], int &NCompleted, int *completed)
	Blocks until one or more of the specified requests in the given request request array completes.

int	TestAll (const int count, Request requests[], int &flag)
	Checks if the given communication request objects are complete.

int	TestAny (const int count, Request requests[], int &idx, int &flag)
	Check if at least one of the specified requests has completed.

int	TestSome (const int count, Request requests[], int &NCompleted, int *completed)
	Checks the status of all the given request communication object handles.

vtkMPICommunicatorOpaqueComm *	GetMPIComm ()

int	InitializeExternal (vtkMPICommunicatorOpaqueComm *comm)

void	CopyFrom (vtkMPICommunicator *source)
	Copies all the attributes of source, deleting previously stored data.


int	SendVoidArray (const void *data, vtkIdType length, int type, int remoteProcessId, int tag) override
	Performs the actual communication.

int	ReceiveVoidArray (void *data, vtkIdType length, int type, int remoteProcessId, int tag) override
	Performs the actual communication.


int	NoBlockSend (const int *data, int length, int remoteProcessId, int tag, Request &req)
	This method sends data to another process (non-blocking).

int	NoBlockSend (const unsigned long *data, int length, int remoteProcessId, int tag, Request &req)
	This method sends data to another process (non-blocking).

int	NoBlockSend (const char *data, int length, int remoteProcessId, int tag, Request &req)
	This method sends data to another process (non-blocking).

int	NoBlockSend (const unsigned char *data, int length, int remoteProcessId, int tag, Request &req)
	This method sends data to another process (non-blocking).

int	NoBlockSend (const float *data, int length, int remoteProcessId, int tag, Request &req)
	This method sends data to another process (non-blocking).

int	NoBlockSend (const double *data, int length, int remoteProcessId, int tag, Request &req)
	This method sends data to another process (non-blocking).


int	NoBlockReceive (int *data, int length, int remoteProcessId, int tag, Request &req)
	This method receives data from a corresponding send (non-blocking).

int	NoBlockReceive (unsigned long *data, int length, int remoteProcessId, int tag, Request &req)
	This method receives data from a corresponding send (non-blocking).

int	NoBlockReceive (char *data, int length, int remoteProcessId, int tag, Request &req)
	This method receives data from a corresponding send (non-blocking).

int	NoBlockReceive (unsigned char *data, int length, int remoteProcessId, int tag, Request &req)
	This method receives data from a corresponding send (non-blocking).

int	NoBlockReceive (float *data, int length, int remoteProcessId, int tag, Request &req)
	This method receives data from a corresponding send (non-blocking).

int	NoBlockReceive (double *data, int length, int remoteProcessId, int tag, Request &req)
	This method receives data from a corresponding send (non-blocking).


void	Barrier () override
	More efficient implementations of collective operations that use the equivalent MPI commands.

int	BroadcastVoidArray (void *data, vtkIdType length, int type, int srcProcessId) override
	More efficient implementations of collective operations that use the equivalent MPI commands.

int	GatherVoidArray (const void sendBuffer, void recvBuffer, vtkIdType length, int type, int destProcessId) override
	More efficient implementations of collective operations that use the equivalent MPI commands.

int	GatherVVoidArray (const void sendBuffer, void recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int type, int destProcessId) override
	More efficient implementations of collective operations that use the equivalent MPI commands.

int	ScatterVoidArray (const void sendBuffer, void recvBuffer, vtkIdType length, int type, int srcProcessId) override
	More efficient implementations of collective operations that use the equivalent MPI commands.

int	ScatterVVoidArray (const void sendBuffer, void recvBuffer, vtkIdType sendLengths, vtkIdType offsets, vtkIdType recvLength, int type, int srcProcessId) override
	More efficient implementations of collective operations that use the equivalent MPI commands.

int	AllGatherVoidArray (const void sendBuffer, void recvBuffer, vtkIdType length, int type) override
	More efficient implementations of collective operations that use the equivalent MPI commands.

int	AllGatherVVoidArray (const void sendBuffer, void recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int type) override
	More efficient implementations of collective operations that use the equivalent MPI commands.

int	ReduceVoidArray (const void sendBuffer, void recvBuffer, vtkIdType length, int type, int operation, int destProcessId) override
	More efficient implementations of collective operations that use the equivalent MPI commands.

int	ReduceVoidArray (const void sendBuffer, void recvBuffer, vtkIdType length, int type, Operation *operation, int destProcessId) override
	More efficient implementations of collective operations that use the equivalent MPI commands.

int	AllReduceVoidArray (const void sendBuffer, void recvBuffer, vtkIdType length, int type, int operation) override
	More efficient implementations of collective operations that use the equivalent MPI commands.

int	AllReduceVoidArray (const void sendBuffer, void recvBuffer, vtkIdType length, int type, Operation *operation) override
	More efficient implementations of collective operations that use the equivalent MPI commands.


int	Iprobe (int source, int tag, int flag, int actualSource)
	Nonblocking test for a message.

int	Iprobe (int source, int tag, int flag, int actualSource, int type, int size)
	Nonblocking test for a message.

int	Iprobe (int source, int tag, int flag, int actualSource, unsigned long type, int size)
	Nonblocking test for a message.

int	Iprobe (int source, int tag, int flag, int actualSource, const char type, int size)
	Nonblocking test for a message.

int	Iprobe (int source, int tag, int flag, int actualSource, float type, int size)
	Nonblocking test for a message.

int	Iprobe (int source, int tag, int flag, int actualSource, double type, int size)
	Nonblocking test for a message.


virtual void	SetUseSsend (int)
	When set to 1, all MPI_Send calls are replaced by MPI_Ssend calls.

virtual int	GetUseSsend ()
	When set to 1, all MPI_Send calls are replaced by MPI_Ssend calls.

virtual void	UseSsendOn ()
	When set to 1, all MPI_Send calls are replaced by MPI_Ssend calls.

virtual void	UseSsendOff ()
	When set to 1, all MPI_Send calls are replaced by MPI_Ssend calls.

Public Member Functions inherited from vtkCommunicator
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkCommunicator *	NewInstance () const

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

int	Send (vtkDataObject *data, int remoteHandle, int tag)
	This method sends a data object to a destination.

int	Send (vtkDataArray *data, int remoteHandle, int tag)
	This method sends a data array to a destination.

virtual int	SendVoidArray (const void *data, vtkIdType length, int type, int remoteHandle, int tag)=0
	Subclasses have to supply this method to send various arrays of data.

int	Send (const vtkMultiProcessStream &stream, int remoteId, int tag)

int	Receive (vtkDataObject *data, int remoteHandle, int tag)
	This method receives a data object from a corresponding send.

vtkDataObject *	ReceiveDataObject (int remoteHandle, int tag)
	The caller does not have to know the data type before this call is made.

int	Receive (vtkDataArray *data, int remoteHandle, int tag)
	This method receives a data array from a corresponding send.

virtual int	ReceiveVoidArray (void *data, vtkIdType maxlength, int type, int remoteHandle, int tag)=0
	Subclasses have to supply this method to receive various arrays of data.

int	Receive (vtkMultiProcessStream &stream, int remoteId, int tag)

virtual void	Barrier ()
	Will block the processes until all other processes reach the Barrier function.

int	Broadcast (vtkMultiProcessStream &stream, int srcProcessId)

int	Gather (vtkDataObject *sendBuffer, std::vector< vtkSmartPointer< vtkDataObject > > &recvBuffer, int destProcessId)
	Gathers vtkDataObject (`sendBuffer`) from all ranks to the `destProcessId`.

int	Gather (const vtkMultiProcessStream &sendBuffer, std::vector< vtkMultiProcessStream > &recvBuffer, int destProcessId)
	Gathers vtkMultiProcessStream (`sendBuffer`) from all ranks to the `destProcessId`.

int	GatherV (vtkDataObject sendData, vtkSmartPointer< vtkDataObject > recvData, int destProcessId)
	Collects data objects in the process with id `destProcessId`.

int	AllGather (vtkDataObject *sendBuffer, std::vector< vtkSmartPointer< vtkDataObject > > &recvBuffer)
	Gathers vtkDataObject (`sendBuffer`) from all ranks to all raks.

virtual int	ComputeGlobalBounds (int processorId, int numProcesses, vtkBoundingBox bounds, int rightHasBounds=nullptr, int *leftHasBounds=nullptr, int hasBoundsTag=288402, int localBoundsTag=288403, int globalBoundsTag=288404)
	Determine the global bounds for a set of processes.

virtual void	SetNumberOfProcesses (int num)
	Set the number of processes you will be using.

virtual int	GetNumberOfProcesses ()
	Set the number of processes you will be using.

virtual int	GetLocalProcessId ()
	Tells you which process [0, NumProcess) you are in.

int	Send (const int *data, vtkIdType length, int remoteHandle, int tag)
	Convenience methods for sending data arrays.

int	Send (const unsigned int *data, vtkIdType length, int remoteHandle, int tag)
	Convenience methods for sending data arrays.

int	Send (const short *data, vtkIdType length, int remoteHandle, int tag)
	Convenience methods for sending data arrays.

int	Send (const unsigned short *data, vtkIdType length, int remoteHandle, int tag)
	Convenience methods for sending data arrays.

int	Send (const long *data, vtkIdType length, int remoteHandle, int tag)
	Convenience methods for sending data arrays.

int	Send (const unsigned long *data, vtkIdType length, int remoteHandle, int tag)
	Convenience methods for sending data arrays.

int	Send (const unsigned char *data, vtkIdType length, int remoteHandle, int tag)
	Convenience methods for sending data arrays.

int	Send (const char *data, vtkIdType length, int remoteHandle, int tag)
	Convenience methods for sending data arrays.

int	Send (const signed char *data, vtkIdType length, int remoteHandle, int tag)
	Convenience methods for sending data arrays.

int	Send (const float *data, vtkIdType length, int remoteHandle, int tag)
	Convenience methods for sending data arrays.

int	Send (const double *data, vtkIdType length, int remoteHandle, int tag)
	Convenience methods for sending data arrays.

int	Send (const long long *data, vtkIdType length, int remoteHandle, int tag)
	Convenience methods for sending data arrays.

int	Send (const unsigned long long *data, vtkIdType length, int remoteHandle, int tag)
	Convenience methods for sending data arrays.

int	Receive (int *data, vtkIdType maxlength, int remoteHandle, int tag)
	Convenience methods for receiving data arrays.

int	Receive (unsigned int *data, vtkIdType maxlength, int remoteHandle, int tag)
	Convenience methods for receiving data arrays.

int	Receive (short *data, vtkIdType maxlength, int remoteHandle, int tag)
	Convenience methods for receiving data arrays.

int	Receive (unsigned short *data, vtkIdType maxlength, int remoteHandle, int tag)
	Convenience methods for receiving data arrays.

int	Receive (long *data, vtkIdType maxlength, int remoteHandle, int tag)
	Convenience methods for receiving data arrays.

int	Receive (unsigned long *data, vtkIdType maxlength, int remoteHandle, int tag)
	Convenience methods for receiving data arrays.

int	Receive (unsigned char *data, vtkIdType maxlength, int remoteHandle, int tag)
	Convenience methods for receiving data arrays.

int	Receive (char *data, vtkIdType maxlength, int remoteHandle, int tag)
	Convenience methods for receiving data arrays.

int	Receive (signed char *data, vtkIdType maxlength, int remoteHandle, int tag)
	Convenience methods for receiving data arrays.

int	Receive (float *data, vtkIdType maxlength, int remoteHandle, int tag)
	Convenience methods for receiving data arrays.

int	Receive (double *data, vtkIdType maxlength, int remoteHandle, int tag)
	Convenience methods for receiving data arrays.

int	Receive (long long *data, vtkIdType maxlength, int remoteHandle, int tag)
	Convenience methods for receiving data arrays.

int	Receive (unsigned long long *data, vtkIdType maxlength, int remoteHandle, int tag)
	Convenience methods for receiving data arrays.

virtual vtkIdType	GetCount ()
	Returns the number of words received by the most recent Receive().

int	Broadcast (int *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Broadcast (unsigned int *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Broadcast (short *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Broadcast (unsigned short *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Broadcast (long *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Broadcast (unsigned long *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Broadcast (unsigned char *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Broadcast (char *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Broadcast (signed char *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Broadcast (float *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Broadcast (double *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Broadcast (long long *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Broadcast (unsigned long long *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Broadcast (vtkDataObject *data, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Broadcast (vtkDataArray *data, int srcProcessId)
	Broadcast sends the array in the process with id `srcProcessId` to all of the other processes.

int	Gather (const int sendBuffer, int recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id `destProcessId`.

int	Gather (const unsigned int sendBuffer, unsigned int recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id `destProcessId`.

int	Gather (const short sendBuffer, short recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id `destProcessId`.

int	Gather (const unsigned short sendBuffer, unsigned short recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id `destProcessId`.

int	Gather (const long sendBuffer, long recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id `destProcessId`.

int	Gather (const unsigned long sendBuffer, unsigned long recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id `destProcessId`.

int	Gather (const unsigned char sendBuffer, unsigned char recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id `destProcessId`.

int	Gather (const char sendBuffer, char recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id `destProcessId`.

int	Gather (const signed char sendBuffer, signed char recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id `destProcessId`.

int	Gather (const float sendBuffer, float recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id `destProcessId`.

int	Gather (const double sendBuffer, double recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id `destProcessId`.

int	Gather (const long long sendBuffer, long long recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id `destProcessId`.

int	Gather (const unsigned long long sendBuffer, unsigned long long recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id `destProcessId`.

int	Gather (vtkDataArray sendBuffer, vtkDataArray recvBuffer, int destProcessId)
	Gather collects arrays in the process with id `destProcessId`.

int	GatherV (const int sendBuffer, int recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)
	GatherV is the vector variant of Gather.

int	GatherV (const unsigned int sendBuffer, unsigned int recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)
	GatherV is the vector variant of Gather.

int	GatherV (const short sendBuffer, short recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)
	GatherV is the vector variant of Gather.

int	GatherV (const unsigned short sendBuffer, unsigned short recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)
	GatherV is the vector variant of Gather.

int	GatherV (const long sendBuffer, long recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)
	GatherV is the vector variant of Gather.

int	GatherV (const unsigned long sendBuffer, unsigned long recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)
	GatherV is the vector variant of Gather.

int	GatherV (const unsigned char sendBuffer, unsigned char recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)
	GatherV is the vector variant of Gather.

int	GatherV (const char sendBuffer, char recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)
	GatherV is the vector variant of Gather.

int	GatherV (const signed char sendBuffer, signed char recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)
	GatherV is the vector variant of Gather.

int	GatherV (const float sendBuffer, float recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)
	GatherV is the vector variant of Gather.

int	GatherV (const double sendBuffer, double recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)
	GatherV is the vector variant of Gather.

int	GatherV (const long long sendBuffer, long long recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)
	GatherV is the vector variant of Gather.

int	GatherV (const unsigned long long sendBuffer, unsigned long long recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)
	GatherV is the vector variant of Gather.

int	GatherV (vtkDataArray sendBuffer, vtkDataArray recvBuffer, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)
	For the first GatherV variant, `recvLengths` and `offsets` known on `destProcessId` and are passed in as parameters For the second GatherV variant, `recvLengths` and `offsets` are not known on `destProcessId`.

int	GatherV (vtkDataArray sendBuffer, vtkDataArray recvBuffer, vtkIdTypeArray recvLengths, vtkIdTypeArray offsets, int destProcessId)
	For the first GatherV variant, `recvLengths` and `offsets` known on `destProcessId` and are passed in as parameters For the second GatherV variant, `recvLengths` and `offsets` are not known on `destProcessId`.

int	GatherV (vtkDataArray sendBuffer, vtkDataArray recvBuffer, int destProcessId)
	For the first GatherV variant, `recvLengths` and `offsets` known on `destProcessId` and are passed in as parameters For the second GatherV variant, `recvLengths` and `offsets` are not known on `destProcessId`.

int	Scatter (const int sendBuffer, int recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id `srcProcessId` and distributes it.

int	Scatter (const unsigned int sendBuffer, unsigned int recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id `srcProcessId` and distributes it.

int	Scatter (const short sendBuffer, short recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id `srcProcessId` and distributes it.

int	Scatter (const unsigned short sendBuffer, unsigned short recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id `srcProcessId` and distributes it.

int	Scatter (const long sendBuffer, long recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id `srcProcessId` and distributes it.

int	Scatter (const unsigned long sendBuffer, unsigned long recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id `srcProcessId` and distributes it.

int	Scatter (const unsigned char sendBuffer, unsigned char recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id `srcProcessId` and distributes it.

int	Scatter (const char sendBuffer, char recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id `srcProcessId` and distributes it.

int	Scatter (const signed char sendBuffer, signed char recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id `srcProcessId` and distributes it.

int	Scatter (const float sendBuffer, float recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id `srcProcessId` and distributes it.

int	Scatter (const double sendBuffer, double recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id `srcProcessId` and distributes it.

int	Scatter (const long long sendBuffer, long long recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id `srcProcessId` and distributes it.

int	Scatter (const unsigned long long sendBuffer, unsigned long long recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id `srcProcessId` and distributes it.

int	Scatter (vtkDataArray sendBuffer, vtkDataArray recvBuffer, int srcProcessId)
	Scatter takes an array in the process with id `srcProcessId` and distributes it.

int	ScatterV (const int sendBuffer, int recvBuffer, vtkIdType sendLengths, vtkIdType offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.

int	ScatterV (const unsigned int sendBuffer, unsigned int recvBuffer, vtkIdType sendLengths, vtkIdType offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.

int	ScatterV (const short sendBuffer, short recvBuffer, vtkIdType sendLengths, vtkIdType offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.

int	ScatterV (const unsigned short sendBuffer, unsigned short recvBuffer, vtkIdType sendLengths, vtkIdType offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.

int	ScatterV (const long sendBuffer, long recvBuffer, vtkIdType sendLengths, vtkIdType offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.

int	ScatterV (const unsigned long sendBuffer, unsigned long recvBuffer, vtkIdType sendLengths, vtkIdType offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.

int	ScatterV (const unsigned char sendBuffer, unsigned char recvBuffer, vtkIdType sendLengths, vtkIdType offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.

int	ScatterV (const char sendBuffer, char recvBuffer, vtkIdType sendLengths, vtkIdType offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.

int	ScatterV (const signed char sendBuffer, signed char recvBuffer, vtkIdType sendLengths, vtkIdType offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.

int	ScatterV (const float sendBuffer, float recvBuffer, vtkIdType sendLengths, vtkIdType offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.

int	ScatterV (const double sendBuffer, double recvBuffer, vtkIdType sendLengths, vtkIdType offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.

int	ScatterV (const long long sendBuffer, long long recvBuffer, vtkIdType sendLengths, vtkIdType offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.

int	ScatterV (const unsigned long long sendBuffer, unsigned long long recvBuffer, vtkIdType sendLengths, vtkIdType offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.

int	AllGather (const int sendBuffer, int recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.

int	AllGather (const unsigned int sendBuffer, unsigned int recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.

int	AllGather (const short sendBuffer, short recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.

int	AllGather (const unsigned short sendBuffer, unsigned short recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.

int	AllGather (const long sendBuffer, long recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.

int	AllGather (const unsigned long sendBuffer, unsigned long recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.

int	AllGather (const unsigned char sendBuffer, unsigned char recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.

int	AllGather (const char sendBuffer, char recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.

int	AllGather (const signed char sendBuffer, signed char recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.

int	AllGather (const float sendBuffer, float recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.

int	AllGather (const double sendBuffer, double recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.

int	AllGather (const long long sendBuffer, long long recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.

int	AllGather (const unsigned long long sendBuffer, unsigned long long recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.

int	AllGather (vtkDataArray sendBuffer, vtkDataArray recvBuffer)
	Same as gather except that the result ends up on all processes.

int	AllGather (const vtkMultiProcessStream &sendBuffer, std::vector< vtkMultiProcessStream > &recvBuffer)
	Same as gather except that the result ends up on all processes.

int	AllGatherV (const int sendBuffer, int recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets)
	Same as GatherV except that the result is placed in all processes.

int	AllGatherV (const unsigned int sendBuffer, unsigned int recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets)
	Same as GatherV except that the result is placed in all processes.

int	AllGatherV (const short sendBuffer, short recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets)
	Same as GatherV except that the result is placed in all processes.

int	AllGatherV (const unsigned short sendBuffer, unsigned short recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets)
	Same as GatherV except that the result is placed in all processes.

int	AllGatherV (const long sendBuffer, long recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets)
	Same as GatherV except that the result is placed in all processes.

int	AllGatherV (const unsigned long sendBuffer, unsigned long recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets)
	Same as GatherV except that the result is placed in all processes.

int	AllGatherV (const unsigned char sendBuffer, unsigned char recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets)
	Same as GatherV except that the result is placed in all processes.

int	AllGatherV (const char sendBuffer, char recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets)
	Same as GatherV except that the result is placed in all processes.

int	AllGatherV (const signed char sendBuffer, signed char recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets)
	Same as GatherV except that the result is placed in all processes.

int	AllGatherV (const float sendBuffer, float recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets)
	Same as GatherV except that the result is placed in all processes.

int	AllGatherV (const double sendBuffer, double recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets)
	Same as GatherV except that the result is placed in all processes.

int	AllGatherV (const long long sendBuffer, long long recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets)
	Same as GatherV except that the result is placed in all processes.

int	AllGatherV (const unsigned long long sendBuffer, unsigned long long recvBuffer, vtkIdType sendLength, vtkIdType recvLengths, vtkIdType offsets)
	Same as GatherV except that the result is placed in all processes.

int	AllGatherV (vtkDataArray sendBuffer, vtkDataArray recvBuffer, vtkIdType recvLengths, vtkIdType offsets)
	Same as GatherV except that the result is placed in all processes.

int	AllGatherV (vtkDataArray sendBuffer, vtkDataArray recvBuffer)
	Same as GatherV except that the result is placed in all processes.

int	Reduce (const int sendBuffer, int recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const unsigned int sendBuffer, unsigned int recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const short sendBuffer, short recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const unsigned short sendBuffer, unsigned short recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const long sendBuffer, long recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const unsigned long sendBuffer, unsigned long recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const unsigned char sendBuffer, unsigned char recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const char sendBuffer, char recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const signed char sendBuffer, signed char recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const float sendBuffer, float recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const double sendBuffer, double recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const long long sendBuffer, long long recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const unsigned long long sendBuffer, unsigned long long recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (vtkDataArray sendBuffer, vtkDataArray recvBuffer, int operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const int sendBuffer, int recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const unsigned int sendBuffer, unsigned int recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const short sendBuffer, short recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const unsigned short sendBuffer, unsigned short recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const long sendBuffer, long recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const unsigned long sendBuffer, unsigned long recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const unsigned char sendBuffer, unsigned char recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const char sendBuffer, char recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const signed char sendBuffer, signed char recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const float sendBuffer, float recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const double sendBuffer, double recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const long long sendBuffer, long long recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (const unsigned long long sendBuffer, unsigned long long recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
	Reduce an array to the given destination process.

int	Reduce (vtkDataArray sendBuffer, vtkDataArray recvBuffer, Operation *operation, int destProcessId)
	Reduce an array to the given destination process.

int	AllReduce (const int sendBuffer, int recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const unsigned int sendBuffer, unsigned int recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const short sendBuffer, short recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const unsigned short sendBuffer, unsigned short recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const long sendBuffer, long recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const unsigned long sendBuffer, unsigned long recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const unsigned char sendBuffer, unsigned char recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const char sendBuffer, char recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const signed char sendBuffer, signed char recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const float sendBuffer, float recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const double sendBuffer, double recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const long long sendBuffer, long long recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const unsigned long long sendBuffer, unsigned long long recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (vtkDataArray sendBuffer, vtkDataArray recvBuffer, int operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const int sendBuffer, int recvBuffer, vtkIdType length, Operation *operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const unsigned int sendBuffer, unsigned int recvBuffer, vtkIdType length, Operation *operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const short sendBuffer, short recvBuffer, vtkIdType length, Operation *operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const unsigned short sendBuffer, unsigned short recvBuffer, vtkIdType length, Operation *operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const long sendBuffer, long recvBuffer, vtkIdType length, Operation *operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const unsigned long sendBuffer, unsigned long recvBuffer, vtkIdType length, Operation *operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const unsigned char sendBuffer, unsigned char recvBuffer, vtkIdType length, Operation *operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const char sendBuffer, char recvBuffer, vtkIdType length, Operation *operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const signed char sendBuffer, signed char recvBuffer, vtkIdType length, Operation *operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const float sendBuffer, float recvBuffer, vtkIdType length, Operation *operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const double sendBuffer, double recvBuffer, vtkIdType length, Operation *operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const long long sendBuffer, long long recvBuffer, vtkIdType length, Operation *operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (const unsigned long long sendBuffer, unsigned long long recvBuffer, vtkIdType length, Operation *operation)
	Same as Reduce except that the result is placed in all of the processes.

int	AllReduce (vtkDataArray sendBuffer, vtkDataArray recvBuffer, Operation *operation)
	Same as Reduce except that the result is placed in all of the processes.

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 vtkMPICommunicator *	SafeDownCast (vtkObjectBase *o)

static vtkMPICommunicator *	New ()
	Creates an empty communicator.

static vtkMPICommunicator *	GetWorldCommunicator ()
	Returns the singleton which behaves as the global communicator (MPI_COMM_WORLD)

static char *	Allocate (size_t size)

static void	Free (char *ptr)

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

static vtkCommunicator *	SafeDownCast (vtkObjectBase *o)

static void	SetUseCopy (int useCopy)

static vtkSmartPointer< vtkDataObject >	UnMarshalDataObject (vtkCharArray *buffer)
	Same as UnMarshalDataObject(vtkCharArray, vtkDataObject) except that this method doesn't need to know the type of the data object a priori.

static int	GetParentProcessor (int pid)
	Some helper functions when dealing with heap tree - based algorithms - we don't need a function for getting the right processor since it is 1 + theLeftProcessor.

static int	GetLeftChildProcessor (int pid)
	Some helper functions when dealing with heap tree - based algorithms - we don't need a function for getting the right processor since it is 1 + theLeftProcessor.

static int	MarshalDataObject (vtkDataObject object, vtkCharArray buffer)
	Convert a data object into a string that can be transmitted and vice versa.

static int	UnMarshalDataObject (vtkCharArray buffer, vtkDataObject object)
	Convert a data object into a string that can be transmitted and vice versa.

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

	vtkMPICommunicator ()

	~vtkMPICommunicator () override

int	InitializeNumberOfProcesses ()

void	InitializeCopy (vtkMPICommunicator *source)

void	Duplicate (vtkMPICommunicator *source)
	Copies all the attributes of source, deleting previously stored data EXCEPT the MPI communicator handle which is duplicated with MPI_Comm_dup().

virtual int	ReceiveDataInternal (char data, int length, int sizeoftype, int remoteProcessId, int tag, vtkMPICommunicatorReceiveDataInfo info, int useCopy, int &senderId)
	Implementation for receive data.


virtual void	SetKeepHandle (int)
	KeepHandle is normally off.

virtual void	KeepHandleOn ()
	KeepHandle is normally off.

virtual void	KeepHandleOff ()
	KeepHandle is normally off.

Protected Member Functions inherited from vtkCommunicator
virtual vtkObjectBase *	NewInstanceInternal () const

int	WriteDataArray (vtkDataArray *object)

int	ReadDataArray (vtkDataArray *object)

	vtkCommunicator ()

	~vtkCommunicator () override

int	SendElementalDataObject (vtkDataObject *data, int remoteHandle, int tag)

int	ReceiveDataObject (vtkDataObject *data, int remoteHandle, int tag, int type=-1)

int	ReceiveElementalDataObject (vtkDataObject *data, int remoteHandle, int tag)

int	ReceiveMultiBlockDataSet (vtkMultiBlockDataSet *data, int remoteHandle, int tag)

int	GatherV (vtkDataArray sendArray, vtkDataArray recvArray, vtkSmartPointer< vtkDataArray > *recvArrays, int destProcessId)
	GatherV collects arrays in the process with id `destProcessId`.

int	GatherVElementalDataObject (vtkDataObject sendData, vtkSmartPointer< vtkDataObject > receiveData, int destProcessId)
	GatherV collects arrays in the process with id `destProcessId`.

int	AllGatherV (vtkDataArray sendBuffer, vtkDataArray recvBuffer, vtkIdTypeArray recvLengthsArray, vtkIdTypeArray offsetsArray)

int	AllGatherV (vtkDataArray sendArray, vtkDataArray recvArray, vtkSmartPointer< vtkDataArray > *recvArrays)

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 &)

Static Protected Member Functions
static int	CheckForMPIError (int err)

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkMPICommunicatorOpaqueComm *	MPIComm

int	Initialized

int	KeepHandle

int	LastSenderId

int	UseSsend

Protected Attributes inherited from vtkCommunicator
int	MaximumNumberOfProcesses

int	NumberOfProcesses

int	LocalProcessId

vtkIdType	Count

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

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

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes
static vtkMPICommunicator *	WorldCommunicator

Static Protected Attributes inherited from vtkCommunicator
static int	UseCopy

Friends
class	vtkMPIController

Detailed Description

Class for creating user defined MPI communicators.

This class can be used to create user defined MPI communicators. The actual creation (with MPI_Comm_create) occurs in Initialize which takes as arguments a super-communicator and a group of process ids. The new communicator is created by including the processes contained in the group. The global communicator (equivalent to MPI_COMM_WORLD) can be obtained using the class method GetWorldCommunicator. It is important to note that this communicator should not be used on the processes not contained in the group. For example, if the group contains processes 0 and 1, controller->SetCommunicator(communicator) would cause an MPI error on any other process.

See also: vtkMPIController vtkProcessGroup

Definition at line 49 of file vtkMPICommunicator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkCommunicator vtkMPICommunicator::Superclass

Definition at line 65 of file vtkMPICommunicator.h.

Constructor & Destructor Documentation

◆ vtkMPICommunicator()

vtkMPICommunicator::vtkMPICommunicator ( )

protected

◆ ~vtkMPICommunicator()

vtkMPICommunicator::~vtkMPICommunicator ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkMPICommunicator::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 vtkCommunicator.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkMPICommunicator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCommunicator.

◆ NewInstance()

vtkMPICommunicator * vtkMPICommunicator::NewInstance ( ) const

◆ PrintSelf()

void vtkMPICommunicator::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 vtkCommunicator.

◆ New()

static vtkMPICommunicator * vtkMPICommunicator::New ( )

static

Creates an empty communicator.

◆ GetWorldCommunicator()

static vtkMPICommunicator * vtkMPICommunicator::GetWorldCommunicator ( )

static

Returns the singleton which behaves as the global communicator (MPI_COMM_WORLD)

◆ Initialize()

int vtkMPICommunicator::Initialize ( vtkProcessGroup * group )

Used to initialize the communicator (i.e.

create the underlying MPI_Comm). The group must be associated with a valid vtkMPICommunicator.

◆ SplitInitialize()

int vtkMPICommunicator::SplitInitialize	(	vtkCommunicator *	oldcomm,
		int	color,
		int	key
	)

Used to initialize the communicator (i.e.

create the underlying MPI_Comm) using MPI_Comm_split on the given communicator. Return values are 1 for success and 0 otherwise.

◆ SendVoidArray()

int vtkMPICommunicator::SendVoidArray	(	const void *	data,
		vtkIdType	length,
		int	type,
		int	remoteProcessId,
		int	tag
	)

overridevirtual

Performs the actual communication.

You will usually use the convenience Send functions defined in the superclass. Return values are 1 for success and 0 otherwise.

Implements vtkCommunicator.

◆ ReceiveVoidArray()

int vtkMPICommunicator::ReceiveVoidArray	(	void *	data,
		vtkIdType	length,
		int	type,
		int	remoteProcessId,
		int	tag
	)

overridevirtual

Performs the actual communication.

You will usually use the convenience Send functions defined in the superclass. Return values are 1 for success and 0 otherwise.

Implements vtkCommunicator.

◆ NoBlockSend() [1/6]

int vtkMPICommunicator::NoBlockSend	(	const int *	data,
		int	length,
		int	remoteProcessId,
		int	tag,
		Request &	req
	)

This method sends data to another process (non-blocking).

Tag eliminates ambiguity when multiple sends or receives exist in the same process. The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message. Return values are 1 for success and 0 otherwise.

◆ NoBlockSend() [2/6]

int vtkMPICommunicator::NoBlockSend	(	const unsigned long *	data,
		int	length,
		int	remoteProcessId,
		int	tag,
		Request &	req
	)

This method sends data to another process (non-blocking).

Tag eliminates ambiguity when multiple sends or receives exist in the same process. The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message. Return values are 1 for success and 0 otherwise.

◆ NoBlockSend() [3/6]

int vtkMPICommunicator::NoBlockSend	(	const char *	data,
		int	length,
		int	remoteProcessId,
		int	tag,
		Request &	req
	)

This method sends data to another process (non-blocking).

Tag eliminates ambiguity when multiple sends or receives exist in the same process. The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message. Return values are 1 for success and 0 otherwise.

◆ NoBlockSend() [4/6]

int vtkMPICommunicator::NoBlockSend	(	const unsigned char *	data,
		int	length,
		int	remoteProcessId,
		int	tag,
		Request &	req
	)

This method sends data to another process (non-blocking).

Tag eliminates ambiguity when multiple sends or receives exist in the same process. The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message. Return values are 1 for success and 0 otherwise.

◆ NoBlockSend() [5/6]

int vtkMPICommunicator::NoBlockSend	(	const float *	data,
		int	length,
		int	remoteProcessId,
		int	tag,
		Request &	req
	)

This method sends data to another process (non-blocking).

Tag eliminates ambiguity when multiple sends or receives exist in the same process. The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message. Return values are 1 for success and 0 otherwise.

◆ NoBlockSend() [6/6]

int vtkMPICommunicator::NoBlockSend	(	const double *	data,
		int	length,
		int	remoteProcessId,
		int	tag,
		Request &	req
	)

This method sends data to another process (non-blocking).

Tag eliminates ambiguity when multiple sends or receives exist in the same process. The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message. Return values are 1 for success and 0 otherwise.

◆ NoBlockReceive() [1/6]

int vtkMPICommunicator::NoBlockReceive	(	int *	data,
		int	length,
		int	remoteProcessId,
		int	tag,
		Request &	req
	)

This method receives data from a corresponding send (non-blocking).

The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message. Return values are 1 for success and 0 otherwise.

◆ NoBlockReceive() [2/6]

int vtkMPICommunicator::NoBlockReceive	(	unsigned long *	data,
		int	length,
		int	remoteProcessId,
		int	tag,
		Request &	req
	)

This method receives data from a corresponding send (non-blocking).

The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message. Return values are 1 for success and 0 otherwise.

◆ NoBlockReceive() [3/6]

int vtkMPICommunicator::NoBlockReceive	(	char *	data,
		int	length,
		int	remoteProcessId,
		int	tag,
		Request &	req
	)

This method receives data from a corresponding send (non-blocking).

The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message. Return values are 1 for success and 0 otherwise.

◆ NoBlockReceive() [4/6]

int vtkMPICommunicator::NoBlockReceive	(	unsigned char *	data,
		int	length,
		int	remoteProcessId,
		int	tag,
		Request &	req
	)

This method receives data from a corresponding send (non-blocking).

The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message. Return values are 1 for success and 0 otherwise.

◆ NoBlockReceive() [5/6]

int vtkMPICommunicator::NoBlockReceive	(	float *	data,
		int	length,
		int	remoteProcessId,
		int	tag,
		Request &	req
	)

This method receives data from a corresponding send (non-blocking).

The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message. Return values are 1 for success and 0 otherwise.

◆ NoBlockReceive() [6/6]

int vtkMPICommunicator::NoBlockReceive	(	double *	data,
		int	length,
		int	remoteProcessId,
		int	tag,
		Request &	req
	)

This method receives data from a corresponding send (non-blocking).

The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message. Return values are 1 for success and 0 otherwise.