VTK  9.0.20200711
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkMultiProcessController Class Referenceabstract

Multiprocessing communication superclass. More...

#include <vtkMultiProcessController.h>

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

Public Types

enum  Errors { RMI_NO_ERROR, RMI_TAG_ERROR, RMI_ARG_ERROR }
 
enum  Consts { ANY_SOURCE = -1, INVALID_SOURCE = -2 }
 
enum  Tags { RMI_TAG = 1, RMI_ARG_TAG = 2, BREAK_RMI_TAG = 3, XML_WRITER_DATA_INFO = 4 }
 
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...
 
vtkMultiProcessControllerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Initialize (int *vtkNotUsed(argc), char ***vtkNotUsed(argv))=0
 This method is for setting up the processes. More...
 
virtual void Initialize (int *vtkNotUsed(argc), char ***vtkNotUsed(argv), int initializedExternally)=0
 This method is for setting up the processes. More...
 
virtual void Finalize ()=0
 This method is for cleaning up. More...
 
virtual void Finalize (int finalizedExternally)=0
 This method is for cleaning up. More...
 
void SetNumberOfProcesses (int num)
 Set the number of processes you will be using. More...
 
int GetNumberOfProcesses ()
 
void SetSingleMethod (vtkProcessFunctionType, void *data)
 Set the SingleMethod to f() and the UserData of the for the method to be executed by all of the processes when SingleMethodExecute is called. More...
 
void SetSingleProcessObject (vtkProcess *p)
 Object-oriented flavor of SetSingleMethod(). More...
 
virtual void SingleMethodExecute ()=0
 Execute the SingleMethod (as define by SetSingleMethod) using this->NumberOfProcesses processes. More...
 
void SetMultipleMethod (int index, vtkProcessFunctionType, void *data)
 Set the MultipleMethod to f() and the UserData of the for the method to be executed by the process index when MultipleMethodExecute is called. More...
 
virtual void MultipleMethodExecute ()=0
 Execute the MultipleMethods (as define by calling SetMultipleMethod for each of the required this->NumberOfProcesses methods) using this->NumberOfProcesses processes. More...
 
int GetLocalProcessId ()
 Tells you which process [0, NumProcess) you are in. More...
 
virtual void CreateOutputWindow ()=0
 This method can be used to tell the controller to create a special output window in which all messages are preceded by the process id. More...
 
virtual vtkMultiProcessControllerCreateSubController (vtkProcessGroup *group)
 Creates a new controller with the processes specified by the given group. More...
 
virtual vtkMultiProcessControllerPartitionController (int localColor, int localKey)
 Partitions this controller based on a coloring. More...
 
virtual unsigned long AddRMI (vtkRMIFunctionType, void *localArg, int tag)
 Register remote method invocation in the receiving process which makes the call. More...
 
virtual int RemoveFirstRMI (int tag)
 Remove the first RMI matching the tag. More...
 
virtual int RemoveRMI (unsigned long id)
 Remove the RMI matching the id. More...
 
virtual void RemoveRMI (vtkRMIFunctionType f, void *arg, int tag)
 Take an RMI away. More...
 
virtual unsigned long AddRMICallback (vtkRMIFunctionType, void *localArg, int tag)
 These methods are a part of the newer API to add multiple rmi callbacks. More...
 
virtual void RemoveAllRMICallbacks (int tag)
 These methods are a part of the newer API to add multiple rmi callbacks. More...
 
virtual bool RemoveRMICallback (unsigned long id)
 Remove a callback. More...
 
void TriggerRMI (int remoteProcessId, void *arg, int argLength, int tag)
 A method to trigger a method invocation in another process. More...
 
void TriggerBreakRMIs ()
 A convenience method. More...
 
void TriggerRMI (int remoteProcessId, const char *arg, int tag)
 Convenience method when the arg is a string. More...
 
void TriggerRMI (int remoteProcessId, int tag)
 Convenience method when there is no argument. More...
 
void TriggerRMIOnAllChildren (void *arg, int argLength, int tag)
 This is a convenicence method to trigger an RMI call on all the "children" of the current node. More...
 
void TriggerRMIOnAllChildren (const char *arg, int tag)
 
void TriggerRMIOnAllChildren (int tag)
 
void BroadcastTriggerRMIOnAllChildren (void *arg, int argLength, int tag)
 
int ProcessRMIs (int reportErrors, int dont_loop=0)
 Calling this method gives control to the controller to start processing RMIs. More...
 
int ProcessRMIs ()
 
int BroadcastProcessRMIs (int reportErrors, int dont_loop=0)
 
virtual void SetBreakFlag (int)
 Setting this flag to 1 will cause the ProcessRMIs loop to return. More...
 
virtual int GetBreakFlag ()
 
virtual void SetBroadcastTriggerRMI (bool)
 Setting this flag to 1 will cause the TriggerRMIOnAllChildren to use a collective broadcast operation to communicate the RMI tag to the satellites. More...
 
virtual bool GetBroadcastTriggerRMI ()
 
virtual void BroadcastTriggerRMIOn ()
 
virtual void BroadcastTriggerRMIOff ()
 
virtual vtkCommunicatorGetCommunicator ()
 Returns the communicator associated with this controller. More...
 
void Barrier ()
 This method can be used to synchronize processes. More...
 
int Send (const int *data, vtkIdType length, int remoteProcessId, int tag)
 This method sends data to another process. More...
 
int Send (const short *data, vtkIdType length, int remoteProcessId, int tag)
 
int Send (const unsigned short *data, vtkIdType length, int remoteProcessId, int tag)
 
int Send (const unsigned int *data, vtkIdType length, int remoteProcessId, int tag)
 
int Send (const unsigned long *data, vtkIdType length, int remoteProcessId, int tag)
 
int Send (const long *data, vtkIdType length, int remoteProcessId, int tag)
 
int Send (const signed char *data, vtkIdType length, int remoteProcessId, int tag)
 
int Send (const char *data, vtkIdType length, int remoteProcessId, int tag)
 
int Send (const unsigned char *data, vtkIdType length, int remoteProcessId, int tag)
 
int Send (const float *data, vtkIdType length, int remoteProcessId, int tag)
 
int Send (const double *data, vtkIdType length, int remoteProcessId, int tag)
 
int Send (const long long *data, vtkIdType length, int remoteProcessId, int tag)
 
int Send (const unsigned long long *data, vtkIdType length, int remoteProcessId, int tag)
 
int Send (vtkDataObject *data, int remoteId, int tag)
 
int Send (vtkDataArray *data, int remoteId, int tag)
 
int Send (const vtkMultiProcessStream &stream, int remoteId, int tag)
 Send a stream to another process. More...
 
int Receive (int *data, vtkIdType maxlength, int remoteProcessId, int tag)
 This method receives data from a corresponding send. More...
 
int Receive (unsigned int *data, vtkIdType maxlength, int remoteProcessId, int tag)
 
int Receive (short *data, vtkIdType maxlength, int remoteProcessId, int tag)
 
int Receive (unsigned short *data, vtkIdType maxlength, int remoteProcessId, int tag)
 
int Receive (long *data, vtkIdType maxlength, int remoteProcessId, int tag)
 
int Receive (unsigned long *data, vtkIdType maxlength, int remoteProcessId, int tag)
 
int Receive (char *data, vtkIdType maxlength, int remoteProcessId, int tag)
 
int Receive (unsigned char *data, vtkIdType maxlength, int remoteProcessId, int tag)
 
int Receive (signed char *data, vtkIdType maxlength, int remoteProcessId, int tag)
 
int Receive (float *data, vtkIdType maxlength, int remoteProcessId, int tag)
 
int Receive (double *data, vtkIdType maxlength, int remoteProcessId, int tag)
 
int Receive (long long *data, vtkIdType maxLength, int remoteProcessId, int tag)
 
int Receive (unsigned long long *data, vtkIdType maxLength, int remoteProcessId, int tag)
 
int Receive (vtkDataObject *data, int remoteId, int tag)
 
int Receive (vtkDataArray *data, int remoteId, int tag)
 
int Receive (vtkMultiProcessStream &stream, int remoteId, int tag)
 Receive a stream from the other processes. More...
 
vtkDataObjectReceiveDataObject (int remoteId, int tag)
 
vtkIdType GetCount ()
 Returns the number of words received by the most recent Receive(). More...
 
int Broadcast (int *data, vtkIdType length, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. More...
 
int Broadcast (unsigned int *data, vtkIdType length, int srcProcessId)
 
int Broadcast (short *data, vtkIdType length, int srcProcessId)
 
int Broadcast (unsigned short *data, vtkIdType length, int srcProcessId)
 
int Broadcast (long *data, vtkIdType length, int srcProcessId)
 
int Broadcast (unsigned long *data, vtkIdType length, int srcProcessId)
 
int Broadcast (unsigned char *data, vtkIdType length, int srcProcessId)
 
int Broadcast (char *data, vtkIdType length, int srcProcessId)
 
int Broadcast (signed char *data, vtkIdType length, int srcProcessId)
 
int Broadcast (float *data, vtkIdType length, int srcProcessId)
 
int Broadcast (double *data, vtkIdType length, int srcProcessId)
 
int Broadcast (long long *data, vtkIdType length, int srcProcessId)
 
int Broadcast (unsigned long long *data, vtkIdType length, int srcProcessId)
 
int Broadcast (vtkDataObject *data, int srcProcessId)
 
int Broadcast (vtkDataArray *data, int srcProcessId)
 
int Broadcast (vtkMultiProcessStream &stream, int srcProcessId)
 
int Gather (const int *sendBuffer, int *recvBuffer, vtkIdType length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. More...
 
int Gather (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const short *sendBuffer, short *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const long *sendBuffer, long *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const char *sendBuffer, char *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const float *sendBuffer, float *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const double *sendBuffer, double *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int destProcessId)
 
int Gather (vtkDataObject *sendBuffer, std::vector< vtkSmartPointer< vtkDataObject >> &recvBuffer, int destProcessId)
 Gathers vtkDataObject (sendBuffer) from all ranks to the destProcessId. More...
 
int Gather (const vtkMultiProcessStream &sendBuffer, std::vector< vtkMultiProcessStream > &recvBuffer, int destProcessId)
 Gathers vtkMultiProcessStream (sendBuffer) from all ranks to the destProcessId. More...
 
int GatherV (const int *sendBuffer, int *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 GatherV is the vector variant of Gather. More...
 
int GatherV (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const short *sendBuffer, short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const long *sendBuffer, long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const char *sendBuffer, char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const float *sendBuffer, float *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const double *sendBuffer, double *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const long long *sendBuffer, long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkIdTypeArray *recvLengths, vtkIdTypeArray *offsets, int destProcessId)
 
int GatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int destProcessId)
 This special form of GatherV will automatically determine recvLengths and offsets to tightly pack the data in the recvBuffer in process order. More...
 
int GatherV (vtkDataObject *sendData, vtkSmartPointer< vtkDataObject > *recvData, int 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. More...
 
int Scatter (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const short *sendBuffer, short *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const long *sendBuffer, long *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const char *sendBuffer, char *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const float *sendBuffer, float *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const double *sendBuffer, double *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int srcProcessId)
 
int ScatterV (const int *sendBuffer, int *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. More...
 
int ScatterV (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const short *sendBuffer, short *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const long *sendBuffer, long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const char *sendBuffer, char *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const float *sendBuffer, float *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const double *sendBuffer, double *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const long long *sendBuffer, long long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int AllGather (const int *sendBuffer, int *recvBuffer, vtkIdType length)
 Same as gather except that the result ends up on all processes. More...
 
int AllGather (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length)
 
int AllGather (const short *sendBuffer, short *recvBuffer, vtkIdType length)
 
int AllGather (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length)
 
int AllGather (const long *sendBuffer, long *recvBuffer, vtkIdType length)
 
int AllGather (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length)
 
int AllGather (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length)
 
int AllGather (const char *sendBuffer, char *recvBuffer, vtkIdType length)
 
int AllGather (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length)
 
int AllGather (const float *sendBuffer, float *recvBuffer, vtkIdType length)
 
int AllGather (const double *sendBuffer, double *recvBuffer, vtkIdType length)
 
int AllGather (const long long *sendBuffer, long long *recvBuffer, vtkIdType length)
 
int AllGather (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length)
 
int AllGather (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer)
 
int AllGather (const vtkMultiProcessStream &sendBuffer, std::vector< vtkMultiProcessStream > &recvBuffer)
 Gathers vtkMultiProcessStream (sendBuffer) from all ranks to the destProcessId. More...
 
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. More...
 
int AllGatherV (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const short *sendBuffer, short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const long *sendBuffer, long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const char *sendBuffer, char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const float *sendBuffer, float *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const double *sendBuffer, double *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const long long *sendBuffer, long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer)
 This special form of AllGatherV will automatically determine recvLengths and offsets to tightly pack the data in the recvBuffer in process order. More...
 
int Reduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, int operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int operation, int destProcessId)
 
int Reduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 
int Reduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 
int Reduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 
int Reduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 
int Reduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 
int Reduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 
int Reduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 
int Reduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 
int Reduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 
int Reduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 
int Reduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 
int Reduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 
int Reduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkCommunicator::Operation *operation, int destProcessId)
 
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. More...
 
int AllReduce (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int operation)
 
int AllReduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
 
int AllReduce (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
 
int AllReduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
 
int AllReduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
 
int AllReduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
 
int AllReduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
 
int AllReduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
 
int AllReduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
 
int AllReduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
 
int AllReduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
 
int AllReduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
 
int AllReduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
 
int AllReduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
 
int AllReduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkCommunicator::Operation *operation)
 
int Reduce (const vtkBoundingBox &sendBuffer, vtkBoundingBox &recvBuffer, int destProcessId)
 Convenience methods to reduce bounds. More...
 
int AllReduce (const vtkBoundingBox &sendBuffer, vtkBoundingBox &recvBuffer)
 
int Reduce (vtkDataArraySelection *sendBuffer, vtkDataArraySelection *recvBuffer, int destProcessId)
 Convenience methods to reduce vtkDataArraySelection. More...
 
int AllReduce (vtkDataArraySelection *sendBuffer, vtkDataArraySelection *recvBuffer)
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMultiProcessControllerSafeDownCast (vtkObjectBase *o)
 
static vtkMultiProcessControllerGetGlobalController ()
 This convenience method returns the controller associated with the local process. More...
 
static int GetBreakRMITag ()
 Accessor to some default tags. More...
 
static int GetRMITag ()
 
static int GetRMIArgTag ()
 
static void SetGlobalController (vtkMultiProcessController *controller)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkMultiProcessController ()
 
 ~vtkMultiProcessController () override
 
virtual void TriggerRMIInternal (int remoteProcessId, void *arg, int argLength, int rmiTag, bool propagate)
 Implementation for TriggerRMI() provides subclasses an opportunity to modify the behaviour eg. More...
 
void GetMultipleMethod (int index, vtkProcessFunctionType &func, void *&data)
 
void ProcessRMI (int remoteProcessId, void *arg, int argLength, int rmiTag)
 
virtual vtkMultiProcessControllerGetLocalController ()
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkProcessFunctionType SingleMethod
 
void * SingleData
 
int BreakFlag
 
int ForceDeepCopy
 
bool BroadcastTriggerRMI
 
vtkOutputWindowOutputWindow
 
vtkCommunicatorCommunicator
 
vtkCommunicatorRMICommunicator
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Multiprocessing communication superclass.

vtkMultiProcessController is used to control multiple processes in a distributed computing environment. It has methods for executing single/multiple method(s) on multiple processors, triggering registered callbacks (Remote Methods) (AddRMI(), TriggerRMI()) and communication. Please note that the communication is done using the communicator which is accessible to the user. Therefore it is possible to get the communicator with GetCommunicator() and use it to send and receive data. This is the encouraged communication method. The internal (RMI) communications are done using a second internal communicator (called RMICommunicator).

There are two modes for RMI communication: (1) Send/Receive mode and (2) Broadcast (collective) mode. The Send/Receive mode arranges processes in a binary tree using post-order traversal and propagates the RMI trigger starting from the root (rank 0) to the children. It is commonly employed to communicate between client/server over TCP. Although, the Send/Receive mode can be employed transparently over TCP or MPI, it is not optimal for triggering the RMIs on the satellite ranks. The Broadcast mode provides a more desirable alternative, namely, it uses MPI_Broadcast for communication, which is the nominal way of achieving this in an MPI context. The underlying communication mode used for triggering RMIs is controlled by the "BroadcastTriggerRMI" variable. Note, that mixing between the two modes for RMI communication is not correct behavior. All processes within the vtkMultiProcessController must use the same mode for triggering RMI.

See also
vtkMPIController vtkCommunicator vtkMPICommunicator

Definition at line 76 of file vtkMultiProcessController.h.

Member Typedef Documentation

◆ Superclass

Definition at line 79 of file vtkMultiProcessController.h.

Member Enumeration Documentation

◆ Errors

Enumerator
RMI_NO_ERROR 
RMI_TAG_ERROR 
RMI_ARG_ERROR 

Definition at line 358 of file vtkMultiProcessController.h.

◆ Consts

Enumerator
ANY_SOURCE 
INVALID_SOURCE 

Definition at line 365 of file vtkMultiProcessController.h.

◆ Tags

Enumerator
RMI_TAG 
RMI_ARG_TAG 
BREAK_RMI_TAG 
XML_WRITER_DATA_INFO 

Definition at line 371 of file vtkMultiProcessController.h.

Constructor & Destructor Documentation

◆ vtkMultiProcessController()

vtkMultiProcessController::vtkMultiProcessController ( )
protected

◆ ~vtkMultiProcessController()

vtkMultiProcessController::~vtkMultiProcessController ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkMPIController, vtkSocketController, and vtkDummyController.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkMultiProcessController::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkMultiProcessController* vtkMultiProcessController::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkMPIController, and vtkSocketController.

◆ Initialize() [1/2]

virtual void vtkMultiProcessController::Initialize ( int *  vtkNotUsedargc,
char ***  vtkNotUsedargv 
)
pure virtual

This method is for setting up the processes.

If a subclass needs to initialize process communication (i.e. MPI) it would over ride this method.

◆ Initialize() [2/2]

virtual void vtkMultiProcessController::Initialize ( int *  vtkNotUsedargc,
char ***  vtkNotUsedargv,
int  initializedExternally 
)
pure virtual

This method is for setting up the processes.

If a subclass needs to initialize process communication (i.e. MPI) it would over ride this method. Provided for initialization outside vtk.

Implemented in vtkMPIController.

◆ Finalize() [1/2]

virtual void vtkMultiProcessController::Finalize ( )
pure virtual

This method is for cleaning up.

If a subclass needs to clean up process communication (i.e. MPI) it would over ride this method.

Implemented in vtkMPIController, vtkSocketController, and vtkDummyController.

◆ Finalize() [2/2]

virtual void vtkMultiProcessController::Finalize ( int  finalizedExternally)
pure virtual

This method is for cleaning up.

If a subclass needs to clean up process communication (i.e. MPI) it would over ride this method. Provided for finalization outside vtk.

Implemented in vtkSocketController, vtkDummyController, and vtkMPIController.

◆ SetNumberOfProcesses()

void vtkMultiProcessController::SetNumberOfProcesses ( int  num)

Set the number of processes you will be using.

This defaults to the maximum number available. If you set this to a value higher than the default, you will get an error.

◆ GetNumberOfProcesses()

int vtkMultiProcessController::GetNumberOfProcesses ( )

◆ SetSingleMethod()

void vtkMultiProcessController::SetSingleMethod ( vtkProcessFunctionType  ,
void *  data 
)

Set the SingleMethod to f() and the UserData of the for the method to be executed by all of the processes when SingleMethodExecute is called.

All the processes will start by calling this function.

◆ SetSingleProcessObject()

void vtkMultiProcessController::SetSingleProcessObject ( vtkProcess p)

Object-oriented flavor of SetSingleMethod().

Instead of passing some function pointer and user data, a vtkProcess object is passed where the method to execute is Execute() and the data the object itself.

◆ SingleMethodExecute()

virtual void vtkMultiProcessController::SingleMethodExecute ( )
pure virtual

Execute the SingleMethod (as define by SetSingleMethod) using this->NumberOfProcesses processes.

This will only return when all the processes finish executing their methods.

Implemented in vtkMPIController, vtkSocketController, and vtkDummyController.

◆ SetMultipleMethod()

void vtkMultiProcessController::SetMultipleMethod ( int  index,
vtkProcessFunctionType  ,
void *  data 
)

Set the MultipleMethod to f() and the UserData of the for the method to be executed by the process index when MultipleMethodExecute is called.

This is for having each process start with a different function and data argument.

◆ MultipleMethodExecute()

virtual void vtkMultiProcessController::MultipleMethodExecute ( )
pure virtual

Execute the MultipleMethods (as define by calling SetMultipleMethod for each of the required this->NumberOfProcesses methods) using this->NumberOfProcesses processes.

Implemented in vtkMPIController, vtkSocketController, and vtkDummyController.

◆ GetLocalProcessId()

int vtkMultiProcessController::GetLocalProcessId ( )

Tells you which process [0, NumProcess) you are in.

◆ GetGlobalController()

static vtkMultiProcessController* vtkMultiProcessController::GetGlobalController ( )
static

This convenience method returns the controller associated with the local process.

It returns nullptr until the processes are spawned. It is better if you hang on to the controller passed as an argument to the SingleMethod or MultipleMethod functions.

◆ CreateOutputWindow()

virtual void vtkMultiProcessController::CreateOutputWindow ( )
pure virtual

This method can be used to tell the controller to create a special output window in which all messages are preceded by the process id.

Implemented in vtkMPIController, vtkSocketController, and vtkDummyController.

◆ CreateSubController()

virtual vtkMultiProcessController* vtkMultiProcessController::CreateSubController ( vtkProcessGroup group)
virtual

Creates a new controller with the processes specified by the given group.

The new controller will already be initialized for you. You are responsible for deleting the controller once you are done. It is invalid to pass this method a group with a different communicator than is used by this controller. This operation is collective across all processes defined in the group. It is undefined what will happen if the group is not the same on all processes. This method must be called by all processes in the controller regardless of whether they are in the group. nullptr is returned on all process not in the group.

Reimplemented in vtkMPIController.

◆ PartitionController()

virtual vtkMultiProcessController* vtkMultiProcessController::PartitionController ( int  localColor,
int  localKey 
)
virtual

Partitions this controller based on a coloring.

That is, each process passes in a color. All processes with the same color are grouped into the same partition. The processes are ordered by their self-assigned key. Lower keys have lower process ids. Ties are broken by the current process ids. (For example, if all the keys are 0, then the resulting processes will be ordered in the same way.) This method returns a new controller to each process that represents the local partition. This is basically the same operation as MPI_Comm_split.

Reimplemented in vtkMPIController.

◆ AddRMI()

virtual unsigned long vtkMultiProcessController::AddRMI ( vtkRMIFunctionType  ,
void *  localArg,
int  tag 
)
virtual

Register remote method invocation in the receiving process which makes the call.

It must have a unique tag as an RMI id. The vtkRMIFunctionType has several arguments: localArg (same as passed in), remoteArg, remoteArgLength (memory passed by process triggering the RMI), remoteProcessId. Since only one callback can be registered per tag, this method will remove any previously registered callback for the given tag. Returns a unique Id for the RMI registration which can be used to unregister the callback. RemoveRMI() should be preferred over RemoveFirstRMI() since it avoid accidental removal of callbacks.

◆ RemoveFirstRMI()

virtual int vtkMultiProcessController::RemoveFirstRMI ( int  tag)
virtual

Remove the first RMI matching the tag.

◆ RemoveRMI() [1/2]

virtual int vtkMultiProcessController::RemoveRMI ( unsigned long  id)
virtual

Remove the RMI matching the id.

The id is the same id returned by AddRMI().

◆ RemoveRMI() [2/2]

virtual void vtkMultiProcessController::RemoveRMI ( vtkRMIFunctionType  f,
void *  arg,
int  tag 
)
inlinevirtual

Take an RMI away.

Definition at line 233 of file vtkMultiProcessController.h.

◆ AddRMICallback()

virtual unsigned long vtkMultiProcessController::AddRMICallback ( vtkRMIFunctionType  ,
void *  localArg,
int  tag 
)
virtual

These methods are a part of the newer API to add multiple rmi callbacks.

When the RMI is triggered, all the callbacks are called Adds a new callback for an RMI. Returns the identifier for the callback.

◆ RemoveAllRMICallbacks()

virtual void vtkMultiProcessController::RemoveAllRMICallbacks ( int  tag)
virtual

These methods are a part of the newer API to add multiple rmi callbacks.

When the RMI is triggered, all the callbacks are called Removes all callbacks for the tag.

◆ RemoveRMICallback()

virtual bool vtkMultiProcessController::RemoveRMICallback ( unsigned long  id)
virtual

Remove a callback.

Returns true is the remove was successful.

◆ TriggerRMI() [1/3]

void vtkMultiProcessController::TriggerRMI ( int  remoteProcessId,
void *  arg,
int  argLength,
int  tag 
)

A method to trigger a method invocation in another process.

◆ TriggerBreakRMIs()

void vtkMultiProcessController::TriggerBreakRMIs ( )

A convenience method.

Called on process 0 to break "ProcessRMIs" loop on all other processes.

◆ TriggerRMI() [2/3]

void vtkMultiProcessController::TriggerRMI ( int  remoteProcessId,
const char *  arg,
int  tag 
)
inline

Convenience method when the arg is a string.

Definition at line 274 of file vtkMultiProcessController.h.

◆ TriggerRMI() [3/3]

void vtkMultiProcessController::TriggerRMI ( int  remoteProcessId,
int  tag 
)
inline

Convenience method when there is no argument.

Definition at line 282 of file vtkMultiProcessController.h.

◆ TriggerRMIOnAllChildren() [1/3]

void vtkMultiProcessController::TriggerRMIOnAllChildren ( void *  arg,
int  argLength,
int  tag 
)

This is a convenicence method to trigger an RMI call on all the "children" of the current node.

The children of the current node can be determined by drawing a binary tree starting at node 0 and then assigned nodes ids incrementally in a breadth-first fashion from left to right. This is designed to be used when trigger an RMI call on all satellites from the root node.

◆ TriggerRMIOnAllChildren() [2/3]

void vtkMultiProcessController::TriggerRMIOnAllChildren ( const char *  arg,
int  tag 
)
inline

Definition at line 297 of file vtkMultiProcessController.h.

◆ TriggerRMIOnAllChildren() [3/3]

void vtkMultiProcessController::TriggerRMIOnAllChildren ( int  tag)
inline

Definition at line 301 of file vtkMultiProcessController.h.

◆ BroadcastTriggerRMIOnAllChildren()

void vtkMultiProcessController::BroadcastTriggerRMIOnAllChildren ( void *  arg,
int  argLength,
int  tag 
)

◆ ProcessRMIs() [1/2]

int vtkMultiProcessController::ProcessRMIs ( int  reportErrors,
int  dont_loop = 0 
)

Calling this method gives control to the controller to start processing RMIs.

Possible return values are: RMI_NO_ERROR, RMI_TAG_ERROR : rmi tag could not be received, RMI_ARG_ERROR : rmi arg could not be received. If reportErrors is false, no vtkErrorMacro is called. ProcessRMIs() calls ProcessRMIs(int) with reportErrors = 0. If dont_loop is 1, this call just process one RMI message and exits.

◆ ProcessRMIs() [2/2]

int vtkMultiProcessController::ProcessRMIs ( )

◆ BroadcastProcessRMIs()

int vtkMultiProcessController::BroadcastProcessRMIs ( int  reportErrors,
int  dont_loop = 0 
)

◆ SetBreakFlag()

virtual void vtkMultiProcessController::SetBreakFlag ( int  )
virtual

Setting this flag to 1 will cause the ProcessRMIs loop to return.

This also causes vtkUpStreamPorts to return from their WaitForUpdate loops.

◆ GetBreakFlag()

virtual int vtkMultiProcessController::GetBreakFlag ( )
virtual

◆ SetBroadcastTriggerRMI()

virtual void vtkMultiProcessController::SetBroadcastTriggerRMI ( bool  )
virtual

Setting this flag to 1 will cause the TriggerRMIOnAllChildren to use a collective broadcast operation to communicate the RMI tag to the satellites.

◆ GetBroadcastTriggerRMI()

virtual bool vtkMultiProcessController::GetBroadcastTriggerRMI ( )
virtual

◆ BroadcastTriggerRMIOn()

virtual void vtkMultiProcessController::BroadcastTriggerRMIOn ( )
virtual

◆ BroadcastTriggerRMIOff()

virtual void vtkMultiProcessController::BroadcastTriggerRMIOff ( )
virtual

◆ GetCommunicator()

virtual vtkCommunicator* vtkMultiProcessController::GetCommunicator ( )
virtual

Returns the communicator associated with this controller.

A default communicator is created in constructor.

◆ GetBreakRMITag()

static int vtkMultiProcessController::GetBreakRMITag ( )
inlinestatic

Accessor to some default tags.

Definition at line 354 of file vtkMultiProcessController.h.

◆ GetRMITag()

static int vtkMultiProcessController::GetRMITag ( )
inlinestatic

Definition at line 355 of file vtkMultiProcessController.h.

◆ GetRMIArgTag()

static int vtkMultiProcessController::GetRMIArgTag ( )
inlinestatic

Definition at line 356 of file vtkMultiProcessController.h.

◆ Barrier()

void vtkMultiProcessController::Barrier ( )
inline

This method can be used to synchronize processes.

Definition at line 1883 of file vtkMultiProcessController.h.

◆ SetGlobalController()

static void vtkMultiProcessController::SetGlobalController ( vtkMultiProcessController controller)
static

◆ Send() [1/16]

int vtkMultiProcessController::Send ( const int *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
)
inline

This method sends data to another process.

Tag eliminates ambiguity when multiple sends or receives exist in the same process. It is recommended to use custom tag number over 100. vtkMultiProcessController has reserved tags between 1 and 4. vtkCommunicator has reserved tags between 10 and 16.

Definition at line 1490 of file vtkMultiProcessController.h.

◆ Send() [2/16]

int vtkMultiProcessController::Send ( const short *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1503 of file vtkMultiProcessController.h.

◆ Send() [3/16]

int vtkMultiProcessController::Send ( const unsigned short *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1516 of file vtkMultiProcessController.h.

◆ Send() [4/16]

int vtkMultiProcessController::Send ( const unsigned int *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1529 of file vtkMultiProcessController.h.

◆ Send() [5/16]

int vtkMultiProcessController::Send ( const unsigned long *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1542 of file vtkMultiProcessController.h.

◆ Send() [6/16]

int vtkMultiProcessController::Send ( const long *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1555 of file vtkMultiProcessController.h.

◆ Send() [7/16]

int vtkMultiProcessController::Send ( const signed char *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1568 of file vtkMultiProcessController.h.

◆ Send() [8/16]

int vtkMultiProcessController::Send ( const char *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1581 of file vtkMultiProcessController.h.

◆ Send() [9/16]

int vtkMultiProcessController::Send ( const unsigned char *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1594 of file vtkMultiProcessController.h.

◆ Send() [10/16]

int vtkMultiProcessController::Send ( const float *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1607 of file vtkMultiProcessController.h.

◆ Send() [11/16]

int vtkMultiProcessController::Send ( const double *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1620 of file vtkMultiProcessController.h.

◆ Send() [12/16]

int vtkMultiProcessController::Send ( const long long *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1633 of file vtkMultiProcessController.h.

◆ Send() [13/16]

int vtkMultiProcessController::Send ( const unsigned long long *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1646 of file vtkMultiProcessController.h.

◆ Send() [14/16]

int vtkMultiProcessController::Send ( vtkDataObject data,
int  remoteId,
int  tag 
)
inline

Definition at line 1466 of file vtkMultiProcessController.h.

◆ Send() [15/16]

int vtkMultiProcessController::Send ( vtkDataArray data,
int  remoteId,
int  tag 
)
inline

Definition at line 1478 of file vtkMultiProcessController.h.

◆ Send() [16/16]

int vtkMultiProcessController::Send ( const vtkMultiProcessStream stream,
int  remoteId,
int  tag 
)
inline

Send a stream to another process.

vtkMultiProcessStream makes it possible to send data with arbitrary length and different base types to the other process(es). Instead of making several Send() requests for each type of arguments, it's generally more efficient to push the arguments into the stream and the send the stream over.

Definition at line 1659 of file vtkMultiProcessController.h.

◆ Receive() [1/16]

int vtkMultiProcessController::Receive ( int *  data,
vtkIdType  maxlength,
int  remoteProcessId,
int  tag 
)
inline

This method receives data from a corresponding send.

It blocks until the receive is finished. It calls methods in "data" to communicate the sending data. In the overrloads that take in a maxlength argument, this length is the maximum length of the message to receive. If the maxlength is less than the length of the message sent by the sender, an error will be flagged. Once a message is received, use the GetCount() method to determine the actual size of the data received.

Definition at line 1705 of file vtkMultiProcessController.h.

◆ Receive() [2/16]

int vtkMultiProcessController::Receive ( unsigned int *  data,
vtkIdType  maxlength,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1718 of file vtkMultiProcessController.h.

◆ Receive() [3/16]

int vtkMultiProcessController::Receive ( short *  data,
vtkIdType  maxlength,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1731 of file vtkMultiProcessController.h.

◆ Receive() [4/16]

int vtkMultiProcessController::Receive ( unsigned short *  data,
vtkIdType  maxlength,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1744 of file vtkMultiProcessController.h.

◆ Receive() [5/16]

int vtkMultiProcessController::Receive ( long *  data,
vtkIdType  maxlength,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1757 of file vtkMultiProcessController.h.

◆ Receive() [6/16]

int vtkMultiProcessController::Receive ( unsigned long *  data,
vtkIdType  maxlength,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1770 of file vtkMultiProcessController.h.

◆ Receive() [7/16]

int vtkMultiProcessController::Receive ( char *  data,
vtkIdType  maxlength,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1783 of file vtkMultiProcessController.h.

◆ Receive() [8/16]

int vtkMultiProcessController::Receive ( unsigned char *  data,
vtkIdType  maxlength,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1796 of file vtkMultiProcessController.h.

◆ Receive() [9/16]

int vtkMultiProcessController::Receive ( signed char *  data,
vtkIdType  maxlength,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1809 of file vtkMultiProcessController.h.

◆ Receive() [10/16]

int vtkMultiProcessController::Receive ( float *  data,
vtkIdType  maxlength,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1822 of file vtkMultiProcessController.h.

◆ Receive() [11/16]

int vtkMultiProcessController::Receive ( double *  data,
vtkIdType  maxlength,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1835 of file vtkMultiProcessController.h.

◆ Receive() [12/16]

int vtkMultiProcessController::Receive ( long long *  data,
vtkIdType  maxLength,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1848 of file vtkMultiProcessController.h.

◆ Receive() [13/16]

int vtkMultiProcessController::Receive ( unsigned long long *  data,
vtkIdType  maxLength,
int  remoteProcessId,
int  tag 
)
inline

Definition at line 1861 of file vtkMultiProcessController.h.

◆ Receive() [14/16]

int vtkMultiProcessController::Receive ( vtkDataObject data,
int  remoteId,
int  tag 
)
inline

Definition at line 1669 of file vtkMultiProcessController.h.

◆ Receive() [15/16]

int vtkMultiProcessController::Receive ( vtkDataArray data,
int  remoteId,
int  tag 
)
inline

Definition at line 1693 of file vtkMultiProcessController.h.

◆ Receive() [16/16]

int vtkMultiProcessController::Receive ( vtkMultiProcessStream stream,
int  remoteId,
int  tag 
)
inline

Receive a stream from the other processes.

Definition at line 1874 of file vtkMultiProcessController.h.

◆ ReceiveDataObject()

vtkDataObject * vtkMultiProcessController::ReceiveDataObject ( int  remoteId,
int  tag 
)
inline

Definition at line 1681 of file vtkMultiProcessController.h.

◆ GetCount()

vtkIdType vtkMultiProcessController::GetCount ( )
inline

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

Note that this is not the number of bytes received, but the number of items of the data-type received by the most recent Receive() eg. if Receive(int*,..) was used, then this returns the number of ints received; if Receive(double*,..) was used, then this returns the number of doubles received etc. The return value is valid only after a successful Receive().

Definition at line 1891 of file vtkMultiProcessController.h.

◆ Broadcast() [1/16]

int vtkMultiProcessController::Broadcast ( int *  data,
vtkIdType  length,
int  srcProcessId 
)
inline

Broadcast sends the array in the process with id srcProcessId to all of the other processes.

All processes must call these method with the same arguments in order for it to complete.

Definition at line 474 of file vtkMultiProcessController.h.

◆ Broadcast() [2/16]

int vtkMultiProcessController::Broadcast ( unsigned int *  data,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 478 of file vtkMultiProcessController.h.

◆ Broadcast() [3/16]

int vtkMultiProcessController::Broadcast ( short *  data,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 482 of file vtkMultiProcessController.h.

◆ Broadcast() [4/16]

int vtkMultiProcessController::Broadcast ( unsigned short *  data,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 486 of file vtkMultiProcessController.h.

◆ Broadcast() [5/16]

int vtkMultiProcessController::Broadcast ( long *  data,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 490 of file vtkMultiProcessController.h.

◆ Broadcast() [6/16]

int vtkMultiProcessController::Broadcast ( unsigned long *  data,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 494 of file vtkMultiProcessController.h.

◆ Broadcast() [7/16]

int vtkMultiProcessController::Broadcast ( unsigned char *  data,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 498 of file vtkMultiProcessController.h.

◆ Broadcast() [8/16]

int vtkMultiProcessController::Broadcast ( char *  data,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 502 of file vtkMultiProcessController.h.

◆ Broadcast() [9/16]

int vtkMultiProcessController::Broadcast ( signed char *  data,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 506 of file vtkMultiProcessController.h.

◆ Broadcast() [10/16]

int vtkMultiProcessController::Broadcast ( float *  data,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 510 of file vtkMultiProcessController.h.

◆ Broadcast() [11/16]

int vtkMultiProcessController::Broadcast ( double *  data,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 514 of file vtkMultiProcessController.h.

◆ Broadcast() [12/16]

int vtkMultiProcessController::Broadcast ( long long *  data,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 518 of file vtkMultiProcessController.h.

◆ Broadcast() [13/16]

int vtkMultiProcessController::Broadcast ( unsigned long long *  data,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 522 of file vtkMultiProcessController.h.

◆ Broadcast() [14/16]

int vtkMultiProcessController::Broadcast ( vtkDataObject data,
int  srcProcessId 
)
inline

Definition at line 526 of file vtkMultiProcessController.h.

◆ Broadcast() [15/16]

int vtkMultiProcessController::Broadcast ( vtkDataArray data,
int  srcProcessId 
)
inline

Definition at line 530 of file vtkMultiProcessController.h.

◆ Broadcast() [16/16]

int vtkMultiProcessController::Broadcast ( vtkMultiProcessStream stream,
int  srcProcessId 
)
inline

Definition at line 536 of file vtkMultiProcessController.h.

◆ Gather() [1/16]

int vtkMultiProcessController::Gather ( const int *  sendBuffer,
int *  recvBuffer,
vtkIdType  length,
int  destProcessId 
)
inline

Gather collects arrays in the process with id destProcessId.

Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The length argument (which must be the same on all processes) is the length of the sendBuffers. The recvBuffer (on the destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

Definition at line 551 of file vtkMultiProcessController.h.

◆ Gather() [2/16]

int vtkMultiProcessController::Gather ( const unsigned int *  sendBuffer,
unsigned int *  recvBuffer,
vtkIdType  length,
int  destProcessId 
)
inline

Definition at line 555 of file vtkMultiProcessController.h.

◆ Gather() [3/16]

int vtkMultiProcessController::Gather ( const short *  sendBuffer,
short *  recvBuffer,
vtkIdType  length,
int  destProcessId 
)
inline

Definition at line 560 of file vtkMultiProcessController.h.

◆ Gather() [4/16]

int vtkMultiProcessController::Gather ( const unsigned short *  sendBuffer,
unsigned short *  recvBuffer,
vtkIdType  length,
int  destProcessId 
)
inline

Definition at line 564 of file vtkMultiProcessController.h.

◆ Gather() [5/16]

int vtkMultiProcessController::Gather ( const long *  sendBuffer,
long *  recvBuffer,
vtkIdType  length,
int  destProcessId 
)
inline

Definition at line 569 of file vtkMultiProcessController.h.

◆ Gather() [6/16]

int vtkMultiProcessController::Gather ( const unsigned long *  sendBuffer,
unsigned long *  recvBuffer,
vtkIdType  length,
int  destProcessId 
)
inline

Definition at line 573 of file vtkMultiProcessController.h.

◆ Gather() [7/16]

int vtkMultiProcessController::Gather ( const unsigned char *  sendBuffer,
unsigned char *  recvBuffer,
vtkIdType  length,
int  destProcessId 
)
inline

Definition at line 578 of file vtkMultiProcessController.h.

◆ Gather() [8/16]

int vtkMultiProcessController::Gather ( const char *  sendBuffer,
char *  recvBuffer,
vtkIdType  length,
int  destProcessId 
)
inline

Definition at line 583 of file vtkMultiProcessController.h.

◆ Gather() [9/16]

int vtkMultiProcessController::Gather ( const signed char *  sendBuffer,
signed char *  recvBuffer,
vtkIdType  length,
int  destProcessId 
)
inline

Definition at line 587 of file vtkMultiProcessController.h.

◆ Gather() [10/16]

int vtkMultiProcessController::Gather ( const float *  sendBuffer,
float *  recvBuffer,
vtkIdType  length,
int  destProcessId 
)
inline

Definition at line 592 of file vtkMultiProcessController.h.

◆ Gather() [11/16]

int vtkMultiProcessController::Gather ( const double *  sendBuffer,
double *  recvBuffer,
vtkIdType  length,
int  destProcessId 
)
inline

Definition at line 596 of file vtkMultiProcessController.h.

◆ Gather() [12/16]

int vtkMultiProcessController::Gather ( const long long *  sendBuffer,
long long *  recvBuffer,
vtkIdType  length,
int  destProcessId 
)
inline

Definition at line 600 of file vtkMultiProcessController.h.

◆ Gather() [13/16]

int vtkMultiProcessController::Gather ( const unsigned long long *  sendBuffer,
unsigned long long *  recvBuffer,
vtkIdType  length,
int  destProcessId 
)
inline

Definition at line 605 of file vtkMultiProcessController.h.

◆ Gather() [14/16]

int vtkMultiProcessController::Gather ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer,
int  destProcessId 
)
inline

Definition at line 610 of file vtkMultiProcessController.h.

◆ Gather() [15/16]

int vtkMultiProcessController::Gather ( vtkDataObject sendBuffer,
std::vector< vtkSmartPointer< vtkDataObject >> &  recvBuffer,
int  destProcessId 
)
inline

Gathers vtkDataObject (sendBuffer) from all ranks to the destProcessId.

Parameters
[in]sendBuffer- data object to send from local process. Can be null if not sending any data from the current process.
[out]recvBuffer- vector of data objects to receive data on the receiving rank (identified by destProcessId). This may be empty or filled with data object instances. If empty, data objects will be created as needed. If not empty, existing data object will be used.
[in]destProcessId- process id to gather on.
Returns
- 1 on success, 0 on failure.

Definition at line 628 of file vtkMultiProcessController.h.

◆ Gather() [16/16]

int vtkMultiProcessController::Gather ( const vtkMultiProcessStream sendBuffer,
std::vector< vtkMultiProcessStream > &  recvBuffer,
int  destProcessId 
)
inline

Gathers vtkMultiProcessStream (sendBuffer) from all ranks to the destProcessId.

Parameters
[in]sendBuffer- vtkMultiProcessStream to send from local process.
[out]recvBuffer- vector of vtkMultiProcessStream instances recevied on the receiving rank (identified by destProcessId).
[in]destProcessId- process id to gather on.
Returns
1 on success, 0 on failure.

Definition at line 643 of file vtkMultiProcessController.h.

◆ GatherV() [1/17]

int vtkMultiProcessController::GatherV ( const int *  sendBuffer,
int *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  destProcessId 
)
inline

GatherV is the vector variant of Gather.

It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.

Definition at line 661 of file vtkMultiProcessController.h.

◆ GatherV() [2/17]

int vtkMultiProcessController::GatherV ( const unsigned int *  sendBuffer,
unsigned int *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  destProcessId 
)
inline

Definition at line 667 of file vtkMultiProcessController.h.

◆ GatherV() [3/17]

int vtkMultiProcessController::GatherV ( const short *  sendBuffer,
short *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  destProcessId 
)
inline

Definition at line 673 of file vtkMultiProcessController.h.

◆ GatherV() [4/17]

int vtkMultiProcessController::GatherV ( const unsigned short *  sendBuffer,
unsigned short *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  destProcessId 
)
inline

Definition at line 679 of file vtkMultiProcessController.h.

◆ GatherV() [5/17]

int vtkMultiProcessController::GatherV ( const long *  sendBuffer,
long *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  destProcessId 
)
inline

Definition at line 685 of file vtkMultiProcessController.h.

◆ GatherV() [6/17]

int vtkMultiProcessController::GatherV ( const unsigned long *  sendBuffer,
unsigned long *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  destProcessId 
)
inline

Definition at line 691 of file vtkMultiProcessController.h.

◆ GatherV() [7/17]

int vtkMultiProcessController::GatherV ( const unsigned char *  sendBuffer,
unsigned char *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  destProcessId 
)
inline

Definition at line 697 of file vtkMultiProcessController.h.

◆ GatherV() [8/17]

int vtkMultiProcessController::GatherV ( const char *  sendBuffer,
char *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  destProcessId 
)
inline

Definition at line 703 of file vtkMultiProcessController.h.

◆ GatherV() [9/17]

int vtkMultiProcessController::GatherV ( const signed char *  sendBuffer,
signed char *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  destProcessId 
)
inline

Definition at line 709 of file vtkMultiProcessController.h.

◆ GatherV() [10/17]

int vtkMultiProcessController::GatherV ( const float *  sendBuffer,
float *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  destProcessId 
)
inline

Definition at line 715 of file vtkMultiProcessController.h.

◆ GatherV() [11/17]

int vtkMultiProcessController::GatherV ( const double *  sendBuffer,
double *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  destProcessId 
)
inline

Definition at line 721 of file vtkMultiProcessController.h.

◆ GatherV() [12/17]

int vtkMultiProcessController::GatherV ( const long long *  sendBuffer,
long long *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  destProcessId 
)
inline

Definition at line 727 of file vtkMultiProcessController.h.

◆ GatherV() [13/17]

int vtkMultiProcessController::GatherV ( const unsigned long long *  sendBuffer,
unsigned long long *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  destProcessId 
)
inline

Definition at line 733 of file vtkMultiProcessController.h.

◆ GatherV() [14/17]

int vtkMultiProcessController::GatherV ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer,
vtkIdType recvLengths,
vtkIdType offsets,
int  destProcessId 
)
inline

Definition at line 741 of file vtkMultiProcessController.h.

◆ GatherV() [15/17]

int vtkMultiProcessController::GatherV ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer,
vtkIdTypeArray recvLengths,
vtkIdTypeArray offsets,
int  destProcessId 
)
inline

Definition at line 746 of file vtkMultiProcessController.h.

◆ GatherV() [16/17]

int vtkMultiProcessController::GatherV ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer,
int  destProcessId 
)
inline

This special form of GatherV will automatically determine recvLengths and offsets to tightly pack the data in the recvBuffer in process order.

It will also resize recvBuffer in order to accommodate the incoming data (unlike the other GatherV variants).

Definition at line 759 of file vtkMultiProcessController.h.

◆ GatherV() [17/17]

int vtkMultiProcessController::GatherV ( vtkDataObject sendData,
vtkSmartPointer< vtkDataObject > *  recvData,
int  destProcessId 
)
inline

Definition at line 763 of file vtkMultiProcessController.h.

◆ Scatter() [1/14]

int vtkMultiProcessController::Scatter ( const int *  sendBuffer,
int *  recvBuffer,
vtkIdType  length,
int  srcProcessId 
)
inline

Scatter takes an array in the process with id srcProcessId and distributes it.

Each process (including the source) receives a portion of the send buffer. Process 0 receives the first length values, process 1 receives the second length values, and so on. Scatter is the inverse operation of Gather.

Definition at line 777 of file vtkMultiProcessController.h.

◆ Scatter() [2/14]

int vtkMultiProcessController::Scatter ( const unsigned int *  sendBuffer,
unsigned int *  recvBuffer,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 781 of file vtkMultiProcessController.h.

◆ Scatter() [3/14]

int vtkMultiProcessController::Scatter ( const short *  sendBuffer,
short *  recvBuffer,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 786 of file vtkMultiProcessController.h.

◆ Scatter() [4/14]

int vtkMultiProcessController::Scatter ( const unsigned short *  sendBuffer,
unsigned short *  recvBuffer,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 790 of file vtkMultiProcessController.h.

◆ Scatter() [5/14]

int vtkMultiProcessController::Scatter ( const long *  sendBuffer,
long *  recvBuffer,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 795 of file vtkMultiProcessController.h.

◆ Scatter() [6/14]

int vtkMultiProcessController::Scatter ( const unsigned long *  sendBuffer,
unsigned long *  recvBuffer,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 799 of file vtkMultiProcessController.h.

◆ Scatter() [7/14]

int vtkMultiProcessController::Scatter ( const unsigned char *  sendBuffer,
unsigned char *  recvBuffer,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 804 of file vtkMultiProcessController.h.

◆ Scatter() [8/14]

int vtkMultiProcessController::Scatter ( const char *  sendBuffer,
char *  recvBuffer,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 809 of file vtkMultiProcessController.h.

◆ Scatter() [9/14]

int vtkMultiProcessController::Scatter ( const signed char *  sendBuffer,
signed char *  recvBuffer,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 813 of file vtkMultiProcessController.h.

◆ Scatter() [10/14]

int vtkMultiProcessController::Scatter ( const float *  sendBuffer,
float *  recvBuffer,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 818 of file vtkMultiProcessController.h.

◆ Scatter() [11/14]

int vtkMultiProcessController::Scatter ( const double *  sendBuffer,
double *  recvBuffer,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 822 of file vtkMultiProcessController.h.

◆ Scatter() [12/14]

int vtkMultiProcessController::Scatter ( const long long *  sendBuffer,
long long *  recvBuffer,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 826 of file vtkMultiProcessController.h.

◆ Scatter() [13/14]

int vtkMultiProcessController::Scatter ( const unsigned long long *  sendBuffer,
unsigned long long *  recvBuffer,
vtkIdType  length,
int  srcProcessId 
)
inline

Definition at line 831 of file vtkMultiProcessController.h.

◆ Scatter() [14/14]

int vtkMultiProcessController::Scatter ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer,
int  srcProcessId 
)
inline

Definition at line 836 of file vtkMultiProcessController.h.

◆ ScatterV() [1/13]

int vtkMultiProcessController::ScatterV ( const int *  sendBuffer,
int *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  srcProcessId 
)
inline

ScatterV is the vector variant of Scatter.

It extends the functionality of Scatter by allowing a varying count of data to each process. ScatterV takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer defined by the sendLengths and offsets arrays.

Definition at line 850 of file vtkMultiProcessController.h.

◆ ScatterV() [2/13]

int vtkMultiProcessController::ScatterV ( const unsigned int *  sendBuffer,
unsigned int *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  srcProcessId 
)
inline

Definition at line 856 of file vtkMultiProcessController.h.

◆ ScatterV() [3/13]

int vtkMultiProcessController::ScatterV ( const short *  sendBuffer,
short *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  srcProcessId 
)
inline

Definition at line 862 of file vtkMultiProcessController.h.

◆ ScatterV() [4/13]

int vtkMultiProcessController::ScatterV ( const unsigned short *  sendBuffer,
unsigned short *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  srcProcessId 
)
inline

Definition at line 868 of file vtkMultiProcessController.h.

◆ ScatterV() [5/13]

int vtkMultiProcessController::ScatterV ( const long *  sendBuffer,
long *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  srcProcessId 
)
inline

Definition at line 874 of file vtkMultiProcessController.h.

◆ ScatterV() [6/13]

int vtkMultiProcessController::ScatterV ( const unsigned long *  sendBuffer,
unsigned long *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  srcProcessId 
)
inline

Definition at line 880 of file vtkMultiProcessController.h.

◆ ScatterV() [7/13]

int vtkMultiProcessController::ScatterV ( const unsigned char *  sendBuffer,
unsigned char *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  srcProcessId 
)
inline

Definition at line 886 of file vtkMultiProcessController.h.

◆ ScatterV() [8/13]

int vtkMultiProcessController::ScatterV ( const char *  sendBuffer,
char *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  srcProcessId 
)
inline

Definition at line 892 of file vtkMultiProcessController.h.

◆ ScatterV() [9/13]

int vtkMultiProcessController::ScatterV ( const signed char *  sendBuffer,
signed char *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  srcProcessId 
)
inline

Definition at line 898 of file vtkMultiProcessController.h.

◆ ScatterV() [10/13]

int vtkMultiProcessController::ScatterV ( const float *  sendBuffer,
float *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  srcProcessId 
)
inline

Definition at line 904 of file vtkMultiProcessController.h.

◆ ScatterV() [11/13]

int vtkMultiProcessController::ScatterV ( const double *  sendBuffer,
double *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  srcProcessId 
)
inline

Definition at line 910 of file vtkMultiProcessController.h.

◆ ScatterV() [12/13]

int vtkMultiProcessController::ScatterV ( const long long *  sendBuffer,
long long *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  srcProcessId 
)
inline

Definition at line 916 of file vtkMultiProcessController.h.

◆ ScatterV() [13/13]

int vtkMultiProcessController::ScatterV ( const unsigned long long *  sendBuffer,
unsigned long long *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  srcProcessId 
)
inline

Definition at line 922 of file vtkMultiProcessController.h.

◆ AllGather() [1/15]

int vtkMultiProcessController::AllGather ( const int *  sendBuffer,
int *  recvBuffer,
vtkIdType  length 
)
inline

Same as gather except that the result ends up on all processes.

Definition at line 934 of file vtkMultiProcessController.h.

◆ AllGather() [2/15]

int vtkMultiProcessController::AllGather ( const unsigned int *  sendBuffer,
unsigned int *  recvBuffer,
vtkIdType  length 
)
inline

Definition at line 938 of file vtkMultiProcessController.h.

◆ AllGather() [3/15]

int vtkMultiProcessController::AllGather ( const short *  sendBuffer,
short *  recvBuffer,
vtkIdType  length 
)
inline

Definition at line 942 of file vtkMultiProcessController.h.

◆ AllGather() [4/15]

int vtkMultiProcessController::AllGather ( const unsigned short *  sendBuffer,
unsigned short *  recvBuffer,
vtkIdType  length 
)
inline

Definition at line 946 of file vtkMultiProcessController.h.

◆ AllGather() [5/15]

int vtkMultiProcessController::AllGather ( const long *  sendBuffer,
long *  recvBuffer,
vtkIdType  length 
)
inline

Definition at line 950 of file vtkMultiProcessController.h.

◆ AllGather() [6/15]

int vtkMultiProcessController::AllGather ( const unsigned long *  sendBuffer,
unsigned long *  recvBuffer,
vtkIdType  length 
)
inline

Definition at line 954 of file vtkMultiProcessController.h.

◆ AllGather() [7/15]

int vtkMultiProcessController::AllGather ( const unsigned char *  sendBuffer,
unsigned char *  recvBuffer,
vtkIdType  length 
)
inline

Definition at line 958 of file vtkMultiProcessController.h.

◆ AllGather() [8/15]

int vtkMultiProcessController::AllGather ( const char *  sendBuffer,
char *  recvBuffer,
vtkIdType  length 
)
inline

Definition at line 962 of file vtkMultiProcessController.h.

◆ AllGather() [9/15]

int vtkMultiProcessController::AllGather ( const signed char *  sendBuffer,
signed char *  recvBuffer,
vtkIdType  length 
)
inline

Definition at line 966 of file vtkMultiProcessController.h.

◆ AllGather() [10/15]

int vtkMultiProcessController::AllGather ( const float *  sendBuffer,
float *  recvBuffer,
vtkIdType  length 
)
inline

Definition at line 970 of file vtkMultiProcessController.h.

◆ AllGather() [11/15]

int vtkMultiProcessController::AllGather ( const double *  sendBuffer,
double *  recvBuffer,
vtkIdType  length 
)
inline

Definition at line 974 of file vtkMultiProcessController.h.

◆ AllGather() [12/15]

int vtkMultiProcessController::AllGather ( const long long *  sendBuffer,
long long *  recvBuffer,
vtkIdType  length 
)
inline

Definition at line 978 of file vtkMultiProcessController.h.

◆ AllGather() [13/15]

int vtkMultiProcessController::AllGather ( const unsigned long long *  sendBuffer,
unsigned long long *  recvBuffer,
vtkIdType  length 
)
inline

Definition at line 982 of file vtkMultiProcessController.h.

◆ AllGather() [14/15]

int vtkMultiProcessController::AllGather ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer 
)
inline

Definition at line 987 of file vtkMultiProcessController.h.

◆ AllGather() [15/15]

int vtkMultiProcessController::AllGather ( const vtkMultiProcessStream sendBuffer,
std::vector< vtkMultiProcessStream > &  recvBuffer 
)
inline

Gathers vtkMultiProcessStream (sendBuffer) from all ranks to the destProcessId.

Parameters
[in]sendBuffer- vtkMultiProcessStream to send from local process.
[out]recvBuffer- vector of vtkMultiProcessStream instances * received.
Returns
1 on success, 0 on failure.

Definition at line 1000 of file vtkMultiProcessController.h.

◆ AllGatherV() [1/15]

int vtkMultiProcessController::AllGatherV ( const int *  sendBuffer,
int *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
)
inline

Same as GatherV except that the result is placed in all processes.

Definition at line 1010 of file vtkMultiProcessController.h.

◆ AllGatherV() [2/15]

int vtkMultiProcessController::AllGatherV ( const unsigned int *  sendBuffer,
unsigned int *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
)
inline

Definition at line 1015 of file vtkMultiProcessController.h.

◆ AllGatherV() [3/15]

int vtkMultiProcessController::AllGatherV ( const short *  sendBuffer,
short *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
)
inline

Definition at line 1020 of file vtkMultiProcessController.h.

◆ AllGatherV() [4/15]

int vtkMultiProcessController::AllGatherV ( const unsigned short *  sendBuffer,
unsigned short *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
)
inline

Definition at line 1025 of file vtkMultiProcessController.h.

◆ AllGatherV() [5/15]

int vtkMultiProcessController::AllGatherV ( const long *  sendBuffer,
long *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
)
inline

Definition at line 1030 of file vtkMultiProcessController.h.

◆ AllGatherV() [6/15]

int vtkMultiProcessController::AllGatherV ( const unsigned long *  sendBuffer,
unsigned long *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
)
inline

Definition at line 1035 of file vtkMultiProcessController.h.

◆ AllGatherV() [7/15]

int vtkMultiProcessController::AllGatherV ( const unsigned char *  sendBuffer,
unsigned char *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
)
inline

Definition at line 1040 of file vtkMultiProcessController.h.

◆ AllGatherV() [8/15]

int vtkMultiProcessController::AllGatherV ( const char *  sendBuffer,
char *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
)
inline

Definition at line 1045 of file vtkMultiProcessController.h.

◆ AllGatherV() [9/15]

int vtkMultiProcessController::AllGatherV ( const signed char *  sendBuffer,
signed char *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
)
inline

Definition at line 1050 of file vtkMultiProcessController.h.

◆ AllGatherV() [10/15]

int vtkMultiProcessController::AllGatherV ( const float *  sendBuffer,
float *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
)
inline

Definition at line 1055 of file vtkMultiProcessController.h.

◆ AllGatherV() [11/15]

int vtkMultiProcessController::AllGatherV ( const double *  sendBuffer,
double *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
)
inline

Definition at line 1060 of file vtkMultiProcessController.h.

◆ AllGatherV() [12/15]

int vtkMultiProcessController::AllGatherV ( const long long *  sendBuffer,
long long *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
)
inline

Definition at line 1065 of file vtkMultiProcessController.h.

◆ AllGatherV() [13/15]

int vtkMultiProcessController::AllGatherV ( const unsigned long long *  sendBuffer,
unsigned long long *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
)
inline

Definition at line 1070 of file vtkMultiProcessController.h.

◆ AllGatherV() [14/15]

int vtkMultiProcessController::AllGatherV ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer,
vtkIdType recvLengths,
vtkIdType offsets 
)
inline

Definition at line 1075 of file vtkMultiProcessController.h.

◆ AllGatherV() [15/15]

int vtkMultiProcessController::AllGatherV ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer 
)
inline

This special form of AllGatherV will automatically determine recvLengths and offsets to tightly pack the data in the recvBuffer in process order.

It will also resize recvBuffer in order to accommodate the incoming data (unlike the other GatherV variants).

Definition at line 1088 of file vtkMultiProcessController.h.

◆ Reduce() [1/30]

int vtkMultiProcessController::Reduce ( const int *  sendBuffer,
int *  recvBuffer,
vtkIdType  length,
int  operation,
int  destProcessId 
)
inline

Reduce an array to the given destination process.

This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.

Definition at line 1099 of file vtkMultiProcessController.h.

◆ Reduce() [2/30]

int vtkMultiProcessController::Reduce ( const unsigned int *  sendBuffer,
unsigned int *  recvBuffer,
vtkIdType  length,
int  operation,
int  destProcessId 
)
inline

Definition at line 1104 of file vtkMultiProcessController.h.

◆ Reduce() [3/30]

int vtkMultiProcessController::Reduce ( const short *  sendBuffer,
short *  recvBuffer,
vtkIdType  length,
int  operation,
int  destProcessId 
)
inline

Definition at line 1109 of file vtkMultiProcessController.h.

◆ Reduce() [4/30]

int vtkMultiProcessController::Reduce ( const unsigned short *  sendBuffer,
unsigned short *  recvBuffer,
vtkIdType  length,
int  operation,
int  destProcessId 
)
inline

Definition at line 1114 of file vtkMultiProcessController.h.

◆ Reduce() [5/30]

int vtkMultiProcessController::Reduce ( const long *  sendBuffer,
long *  recvBuffer,
vtkIdType  length,
int  operation,
int  destProcessId 
)
inline

Definition at line 1119 of file vtkMultiProcessController.h.

◆ Reduce() [6/30]

int vtkMultiProcessController::Reduce ( const unsigned long *  sendBuffer,
unsigned long *  recvBuffer,
vtkIdType  length,
int  operation,
int  destProcessId 
)
inline

Definition at line 1124 of file vtkMultiProcessController.h.

◆ Reduce() [7/30]

int vtkMultiProcessController::Reduce ( const unsigned char *  sendBuffer,
unsigned char *  recvBuffer,
vtkIdType  length,
int  operation,
int  destProcessId 
)
inline

Definition at line 1129 of file vtkMultiProcessController.h.

◆ Reduce() [8/30]

int vtkMultiProcessController::Reduce ( const char *  sendBuffer,
char *  recvBuffer,
vtkIdType  length,
int  operation,
int  destProcessId 
)
inline

Definition at line 1134 of file vtkMultiProcessController.h.

◆ Reduce() [9/30]

int vtkMultiProcessController::Reduce ( const signed char *  sendBuffer,
signed char *  recvBuffer,
vtkIdType  length,
int  operation,
int  destProcessId 
)
inline

Definition at line 1139 of file vtkMultiProcessController.h.

◆ Reduce() [10/30]

int vtkMultiProcessController::Reduce ( const float *  sendBuffer,
float *  recvBuffer,
vtkIdType  length,
int  operation,
int  destProcessId 
)
inline

Definition at line 1144 of file vtkMultiProcessController.h.

◆ Reduce() [11/30]

int vtkMultiProcessController::Reduce ( const double *  sendBuffer,
double *  recvBuffer,
vtkIdType  length,
int  operation,
int  destProcessId 
)
inline

Definition at line 1149 of file vtkMultiProcessController.h.

◆ Reduce() [12/30]

int vtkMultiProcessController::Reduce ( const long long *  sendBuffer,
long long *  recvBuffer,
vtkIdType  length,
int  operation,
int  destProcessId 
)
inline

Definition at line 1154 of file vtkMultiProcessController.h.

◆ Reduce() [13/30]

int vtkMultiProcessController::Reduce ( const unsigned long long *  sendBuffer,
unsigned long long *  recvBuffer,
vtkIdType  length,
int  operation,
int  destProcessId 
)
inline

Definition at line 1159 of file vtkMultiProcessController.h.

◆ Reduce() [14/30]

int vtkMultiProcessController::Reduce ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer,
int  operation,
int  destProcessId 
)
inline

Definition at line 1164 of file vtkMultiProcessController.h.

◆ Reduce() [15/30]

int vtkMultiProcessController::Reduce ( const int *  sendBuffer,
int *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation,
int  destProcessId 
)
inline

Reduce an array to the given destination process.

This version of Reduce takes a custom operation as a subclass of vtkCommunicator::Operation.

Definition at line 1175 of file vtkMultiProcessController.h.

◆ Reduce() [16/30]

int vtkMultiProcessController::Reduce ( const unsigned int *  sendBuffer,
unsigned int *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation,
int  destProcessId 
)
inline

Definition at line 1180 of file vtkMultiProcessController.h.

◆ Reduce() [17/30]

int vtkMultiProcessController::Reduce ( const short *  sendBuffer,
short *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation,
int  destProcessId 
)
inline

Definition at line 1185 of file vtkMultiProcessController.h.

◆ Reduce() [18/30]

int vtkMultiProcessController::Reduce ( const unsigned short *  sendBuffer,
unsigned short *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation,
int  destProcessId 
)
inline

Definition at line 1190 of file vtkMultiProcessController.h.

◆ Reduce() [19/30]

int vtkMultiProcessController::Reduce ( const long *  sendBuffer,
long *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation,
int  destProcessId 
)
inline

Definition at line 1195 of file vtkMultiProcessController.h.

◆ Reduce() [20/30]

int vtkMultiProcessController::Reduce ( const unsigned long *  sendBuffer,
unsigned long *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation,
int  destProcessId 
)
inline

Definition at line 1200 of file vtkMultiProcessController.h.

◆ Reduce() [21/30]

int vtkMultiProcessController::Reduce ( const unsigned char *  sendBuffer,
unsigned char *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation,
int  destProcessId 
)
inline

Definition at line 1205 of file vtkMultiProcessController.h.

◆ Reduce() [22/30]

int vtkMultiProcessController::Reduce ( const char *  sendBuffer,
char *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation,
int  destProcessId 
)
inline

Definition at line 1210 of file vtkMultiProcessController.h.

◆ Reduce() [23/30]

int vtkMultiProcessController::Reduce ( const signed char *  sendBuffer,
signed char *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation,
int  destProcessId 
)
inline

Definition at line 1215 of file vtkMultiProcessController.h.

◆ Reduce() [24/30]

int vtkMultiProcessController::Reduce ( const float *  sendBuffer,
float *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation,
int  destProcessId 
)
inline

Definition at line 1220 of file vtkMultiProcessController.h.

◆ Reduce() [25/30]

int vtkMultiProcessController::Reduce ( const double *  sendBuffer,
double *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation,
int  destProcessId 
)
inline

Definition at line 1225 of file vtkMultiProcessController.h.

◆ Reduce() [26/30]

int vtkMultiProcessController::Reduce ( const long long *  sendBuffer,
long long *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation,
int  destProcessId 
)
inline

Definition at line 1230 of file vtkMultiProcessController.h.

◆ Reduce() [27/30]

int vtkMultiProcessController::Reduce ( const unsigned long long *  sendBuffer,
unsigned long long *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation,
int  destProcessId 
)
inline

Definition at line 1235 of file vtkMultiProcessController.h.

◆ Reduce() [28/30]

int vtkMultiProcessController::Reduce ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer,
vtkCommunicator::Operation operation,
int  destProcessId 
)
inline

Definition at line 1240 of file vtkMultiProcessController.h.

◆ AllReduce() [1/30]

int vtkMultiProcessController::AllReduce ( const int *  sendBuffer,
int *  recvBuffer,
vtkIdType  length,
int  operation 
)
inline

Same as Reduce except that the result is placed in all of the processes.

Definition at line 1251 of file vtkMultiProcessController.h.

◆ AllReduce() [2/30]

int vtkMultiProcessController::AllReduce ( const unsigned int *  sendBuffer,
unsigned int *  recvBuffer,
vtkIdType  length,
int  operation 
)
inline

Definition at line 1255 of file vtkMultiProcessController.h.

◆ AllReduce() [3/30]

int vtkMultiProcessController::AllReduce ( const short *  sendBuffer,
short *  recvBuffer,
vtkIdType  length,
int  operation 
)
inline

Definition at line 1260 of file vtkMultiProcessController.h.

◆ AllReduce() [4/30]

int vtkMultiProcessController::AllReduce ( const unsigned short *  sendBuffer,
unsigned short *  recvBuffer,
vtkIdType  length,
int  operation 
)
inline

Definition at line 1264 of file vtkMultiProcessController.h.

◆ AllReduce() [5/30]

int vtkMultiProcessController::AllReduce ( const long *  sendBuffer,
long *  recvBuffer,
vtkIdType  length,
int  operation 
)
inline

Definition at line 1269 of file vtkMultiProcessController.h.

◆ AllReduce() [6/30]

int vtkMultiProcessController::AllReduce ( const unsigned long *  sendBuffer,
unsigned long *  recvBuffer,
vtkIdType  length,
int  operation 
)
inline

Definition at line 1273 of file vtkMultiProcessController.h.

◆ AllReduce() [7/30]

int vtkMultiProcessController::AllReduce ( const unsigned char *  sendBuffer,
unsigned char *  recvBuffer,
vtkIdType  length,
int  operation 
)
inline

Definition at line 1278 of file vtkMultiProcessController.h.

◆ AllReduce() [8/30]

int vtkMultiProcessController::AllReduce ( const char *  sendBuffer,
char *  recvBuffer,
vtkIdType  length,
int  operation 
)
inline

Definition at line 1283 of file vtkMultiProcessController.h.

◆ AllReduce() [9/30]

int vtkMultiProcessController::AllReduce ( const signed char *  sendBuffer,
signed char *  recvBuffer,
vtkIdType  length,
int  operation 
)
inline

Definition at line 1287 of file vtkMultiProcessController.h.

◆ AllReduce() [10/30]

int vtkMultiProcessController::AllReduce ( const float *  sendBuffer,
float *  recvBuffer,
vtkIdType  length,
int  operation 
)
inline

Definition at line 1292 of file vtkMultiProcessController.h.

◆ AllReduce() [11/30]

int vtkMultiProcessController::AllReduce ( const double *  sendBuffer,
double *  recvBuffer,
vtkIdType  length,
int  operation 
)
inline

Definition at line 1296 of file vtkMultiProcessController.h.

◆ AllReduce() [12/30]

int vtkMultiProcessController::AllReduce ( const long long *  sendBuffer,
long long *  recvBuffer,
vtkIdType  length,
int  operation 
)
inline

Definition at line 1300 of file vtkMultiProcessController.h.

◆ AllReduce() [13/30]

int vtkMultiProcessController::AllReduce ( const unsigned long long *  sendBuffer,
unsigned long long *  recvBuffer,
vtkIdType  length,
int  operation 
)
inline

Definition at line 1304 of file vtkMultiProcessController.h.

◆ AllReduce() [14/30]

int vtkMultiProcessController::AllReduce ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer,
int  operation 
)
inline

Definition at line 1309 of file vtkMultiProcessController.h.

◆ AllReduce() [15/30]

int vtkMultiProcessController::AllReduce ( const int *  sendBuffer,
int *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation 
)
inline

Definition at line 1315 of file vtkMultiProcessController.h.

◆ AllReduce() [16/30]

int vtkMultiProcessController::AllReduce ( const unsigned int *  sendBuffer,
unsigned int *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation 
)
inline

Definition at line 1320 of file vtkMultiProcessController.h.

◆ AllReduce() [17/30]

int vtkMultiProcessController::AllReduce ( const short *  sendBuffer,
short *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation 
)
inline

Definition at line 1325 of file vtkMultiProcessController.h.

◆ AllReduce() [18/30]

int vtkMultiProcessController::AllReduce ( const unsigned short *  sendBuffer,
unsigned short *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation 
)
inline

Definition at line 1330 of file vtkMultiProcessController.h.

◆ AllReduce() [19/30]

int vtkMultiProcessController::AllReduce ( const long *  sendBuffer,
long *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation 
)
inline

Definition at line 1335 of file vtkMultiProcessController.h.

◆ AllReduce() [20/30]

int vtkMultiProcessController::AllReduce ( const unsigned long *  sendBuffer,
unsigned long *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation 
)
inline

Definition at line 1340 of file vtkMultiProcessController.h.

◆ AllReduce() [21/30]

int vtkMultiProcessController::AllReduce ( const unsigned char *  sendBuffer,
unsigned char *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation 
)
inline

Definition at line 1345 of file vtkMultiProcessController.h.

◆ AllReduce() [22/30]

int vtkMultiProcessController::AllReduce ( const char *  sendBuffer,
char *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation 
)
inline

Definition at line 1350 of file vtkMultiProcessController.h.

◆ AllReduce() [23/30]

int vtkMultiProcessController::AllReduce ( const signed char *  sendBuffer,
signed char *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation 
)
inline

Definition at line 1355 of file vtkMultiProcessController.h.

◆ AllReduce() [24/30]

int vtkMultiProcessController::AllReduce ( const float *  sendBuffer,
float *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation 
)
inline

Definition at line 1360 of file vtkMultiProcessController.h.

◆ AllReduce() [25/30]

int vtkMultiProcessController::AllReduce ( const double *  sendBuffer,
double *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation 
)
inline

Definition at line 1365 of file vtkMultiProcessController.h.

◆ AllReduce() [26/30]

int vtkMultiProcessController::AllReduce ( const long long *  sendBuffer,
long long *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation 
)
inline

Definition at line 1370 of file vtkMultiProcessController.h.

◆ AllReduce() [27/30]

int vtkMultiProcessController::AllReduce ( const unsigned long long *  sendBuffer,
unsigned long long *  recvBuffer,
vtkIdType  length,
vtkCommunicator::Operation operation 
)
inline

Definition at line 1375 of file vtkMultiProcessController.h.

◆ AllReduce() [28/30]

int vtkMultiProcessController::AllReduce ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer,
vtkCommunicator::Operation operation 
)
inline

Definition at line 1380 of file vtkMultiProcessController.h.

◆ Reduce() [29/30]

int vtkMultiProcessController::Reduce ( const vtkBoundingBox sendBuffer,
vtkBoundingBox recvBuffer,
int  destProcessId 
)

Convenience methods to reduce bounds.

◆ AllReduce() [29/30]

int vtkMultiProcessController::AllReduce ( const vtkBoundingBox sendBuffer,
vtkBoundingBox recvBuffer 
)

◆ Reduce() [30/30]

int vtkMultiProcessController::Reduce ( vtkDataArraySelection sendBuffer,
vtkDataArraySelection recvBuffer,
int  destProcessId 
)

Convenience methods to reduce vtkDataArraySelection.

◆ AllReduce() [30/30]

int vtkMultiProcessController::AllReduce ( vtkDataArraySelection sendBuffer,
vtkDataArraySelection recvBuffer 
)

◆ TriggerRMIInternal()

virtual void vtkMultiProcessController::TriggerRMIInternal ( int  remoteProcessId,
void *  arg,
int  argLength,
int  rmiTag,
bool  propagate 
)
protectedvirtual

Implementation for TriggerRMI() provides subclasses an opportunity to modify the behaviour eg.

MPIController provides ability to use SSend instead of Send.

Reimplemented in vtkMPIController.

◆ GetMultipleMethod()

void vtkMultiProcessController::GetMultipleMethod ( int  index,
vtkProcessFunctionType func,
void *&  data 
)
protected

◆ ProcessRMI()

void vtkMultiProcessController::ProcessRMI ( int  remoteProcessId,
void *  arg,
int  argLength,
int  rmiTag 
)
protected

◆ GetLocalController()

virtual vtkMultiProcessController* vtkMultiProcessController::GetLocalController ( )
protectedvirtual

Member Data Documentation

◆ SingleMethod

vtkProcessFunctionType vtkMultiProcessController::SingleMethod
protected

Definition at line 1417 of file vtkMultiProcessController.h.

◆ SingleData

void* vtkMultiProcessController::SingleData
protected

Definition at line 1418 of file vtkMultiProcessController.h.

◆ BreakFlag

int vtkMultiProcessController::BreakFlag
protected

Definition at line 1424 of file vtkMultiProcessController.h.

◆ ForceDeepCopy

int vtkMultiProcessController::ForceDeepCopy
protected

Definition at line 1433 of file vtkMultiProcessController.h.

◆ BroadcastTriggerRMI

bool vtkMultiProcessController::BroadcastTriggerRMI
protected

Definition at line 1438 of file vtkMultiProcessController.h.

◆ OutputWindow

vtkOutputWindow* vtkMultiProcessController::OutputWindow
protected

Definition at line 1440 of file vtkMultiProcessController.h.

◆ Communicator

vtkCommunicator* vtkMultiProcessController::Communicator
protected

Definition at line 1445 of file vtkMultiProcessController.h.

◆ RMICommunicator

vtkCommunicator* vtkMultiProcessController::RMICommunicator
protected

Definition at line 1454 of file vtkMultiProcessController.h.


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