VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes | Friends | List of all members
vtkMPIController Class Reference

Process communication using MPI. More...

#include <vtkMPIController.h>

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

Public Types

typedef vtkMultiProcessController Superclass
 
- Public Types inherited from vtkMultiProcessController
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 int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkMPIControllerNewInstance () 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 *argc, char ***argv) override
 This method is for setting up the processes. More...
 
virtual void Initialize (int *vtkNotUsed(argc), char ***vtkNotUsed(argv), int initializedExternally) override
 This method is for setting up the processes. More...
 
virtual void Initialize ()
 Same as Initialize(0, 0, 1). More...
 
virtual void Finalize () override
 This method is for cleaning up and has to be called before the end of the program if MPI was initialized with Initialize() More...
 
virtual void Finalize (int finalizedExternally) override
 This method is for cleaning up. More...
 
virtual void SingleMethodExecute () override
 Execute the SingleMethod (as define by SetSingleMethod) using this->NumberOfProcesses processes. More...
 
virtual void MultipleMethodExecute () override
 Execute the MultipleMethods (as define by calling SetMultipleMethod for each of the required this->NumberOfProcesses methods) using this->NumberOfProcesses processes. More...
 
virtual void CreateOutputWindow () override
 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...
 
void SetCommunicator (vtkMPICommunicator *comm)
 MPIController uses this communicator in all sends and receives. More...
 
virtual vtkMPIControllerCreateSubController (vtkProcessGroup *group) override
 Creates a new controller with the processes specified by the given group. More...
 
virtual vtkMPIControllerPartitionController (int localColor, int localKey) override
 Partitions this controller based on a coloring. More...
 
int NoBlockSend (const int *data, int length, int remoteProcessId, int tag, vtkMPICommunicator::Request &req)
 This method sends data to another process (non-blocking). More...
 
int NoBlockSend (const unsigned long *data, int length, int remoteProcessId, int tag, vtkMPICommunicator::Request &req)
 
int NoBlockSend (const char *data, int length, int remoteProcessId, int tag, vtkMPICommunicator::Request &req)
 
int NoBlockSend (const unsigned char *data, int length, int remoteProcessId, int tag, vtkMPICommunicator::Request &req)
 
int NoBlockSend (const float *data, int length, int remoteProcessId, int tag, vtkMPICommunicator::Request &req)
 
int NoBlockSend (const double *data, int length, int remoteProcessId, int tag, vtkMPICommunicator::Request &req)
 
int NoBlockReceive (int *data, int length, int remoteProcessId, int tag, vtkMPICommunicator::Request &req)
 This method receives data from a corresponding send (non-blocking). More...
 
int NoBlockReceive (unsigned long *data, int length, int remoteProcessId, int tag, vtkMPICommunicator::Request &req)
 
int NoBlockReceive (char *data, int length, int remoteProcessId, int tag, vtkMPICommunicator::Request &req)
 
int NoBlockReceive (unsigned char *data, int length, int remoteProcessId, int tag, vtkMPICommunicator::Request &req)
 
int NoBlockReceive (float *data, int length, int remoteProcessId, int tag, vtkMPICommunicator::Request &req)
 
int NoBlockReceive (double *data, int length, int remoteProcessId, int tag, vtkMPICommunicator::Request &req)
 
int Iprobe (int source, int tag, int *flag, int *actualSource)
 Nonblocking test for a message. More...
 
int Iprobe (int source, int tag, int *flag, int *actualSource, int *type, int *size)
 
int Iprobe (int source, int tag, int *flag, int *actualSource, unsigned long *type, int *size)
 
int Iprobe (int source, int tag, int *flag, int *actualSource, const char *type, int *size)
 
int Iprobe (int source, int tag, int *flag, int *actualSource, float *type, int *size)
 
int Iprobe (int source, int tag, int *flag, int *actualSource, double *type, int *size)
 
int WaitAll (const int count, vtkMPICommunicator::Request requests[])
 Given the request objects of a set of non-blocking operations (send and/or receive) this method blocks until all requests are complete. More...
 
int WaitAny (const int count, vtkMPICommunicator::Request requests[], int &idx)
 Blocks until one of the specified requests in the given request array completes. More...
 
int WaitSome (const int count, vtkMPICommunicator::Request requests[], vtkIntArray *completed)
 Blocks until one or more of the specified requests in the given request request array completes. More...
 
bool TestAll (const int count, vtkMPICommunicator::Request requests[])
 Returns true iff all of the communication request objects are complete. More...
 
bool TestAny (const int count, vtkMPICommunicator::Request requests[], int &idx)
 Returns true iff at least one of the communication request objects is complete. More...
 
bool TestSome (const int count, vtkMPICommunicator::Request requests[], vtkIntArray *completed)
 Return true iff one or more of the communicator request objects is complete. More...
 
- Public Member Functions inherited from vtkMultiProcessController
vtkMultiProcessControllerNewInstance () const
 
virtual void Initialize (int *vtkNotUsed(argc), char ***vtkNotUsed(argv))=0
 This method is for setting up the processes. More...
 
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...
 
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...
 
int GetLocalProcessId ()
 Tells you which process [0, NumProcess) you are in. 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 conveniance 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 Barrier ()
 This method can be used to synchronize processes. More...
 
int Send (const vtkMultiProcessStream &stream, int remoteId, int tag)
 Send a stream to another process. More...
 
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 (vtkMultiProcessStream &stream, int srcProcessId)
 
int Gather (vtkDataObject *sendBuffer, std::vector< vtkSmartPointer< vtkDataObject > > &recvBuffer, int destProcessId)
 Gathers vtkDataObject (sendBuffer) from all ranks to the destProcessId. More...
 
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 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 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)
 
void SetNumberOfProcesses (int num)
 Set the number of processes you will be using. More...
 
int GetNumberOfProcesses ()
 Set the number of processes you will be using. 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)
 This is a convenicence method to trigger an RMI call on all the "children" of the current node. More...
 
void TriggerRMIOnAllChildren (int tag)
 This is a convenicence method to trigger an RMI call on all the "children" of the current node. More...
 
void BroadcastTriggerRMIOnAllChildren (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...
 
int ProcessRMIs (int reportErrors, int dont_loop=0)
 Calling this method gives control to the controller to start processing RMIs. More...
 
int ProcessRMIs ()
 Calling this method gives control to the controller to start processing RMIs. More...
 
int BroadcastProcessRMIs (int reportErrors, int dont_loop=0)
 Calling this method gives control to the controller to start processing RMIs. More...
 
virtual void SetBreakFlag (int)
 Setting this flag to 1 will cause the ProcessRMIs loop to return. More...
 
virtual int GetBreakFlag ()
 Setting this flag to 1 will cause the ProcessRMIs loop to return. More...
 
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 ()
 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 void BroadcastTriggerRMIOn ()
 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 void BroadcastTriggerRMIOff ()
 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 vtkCommunicatorGetCommunicator ()
 Returns the communicator associated with this controller. 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)
 This method sends data to another process. More...
 
int Send (const unsigned short *data, vtkIdType length, int remoteProcessId, int tag)
 This method sends data to another process. More...
 
int Send (const unsigned int *data, vtkIdType length, int remoteProcessId, int tag)
 This method sends data to another process. More...
 
int Send (const unsigned long *data, vtkIdType length, int remoteProcessId, int tag)
 This method sends data to another process. More...
 
int Send (const long *data, vtkIdType length, int remoteProcessId, int tag)
 This method sends data to another process. More...
 
int Send (const signed char *data, vtkIdType length, int remoteProcessId, int tag)
 This method sends data to another process. More...
 
int Send (const char *data, vtkIdType length, int remoteProcessId, int tag)
 This method sends data to another process. More...
 
int Send (const unsigned char *data, vtkIdType length, int remoteProcessId, int tag)
 This method sends data to another process. More...
 
int Send (const float *data, vtkIdType length, int remoteProcessId, int tag)
 This method sends data to another process. More...
 
int Send (const double *data, vtkIdType length, int remoteProcessId, int tag)
 This method sends data to another process. More...
 
int Send (const long long *data, vtkIdType length, int remoteProcessId, int tag)
 This method sends data to another process. More...
 
int Send (const unsigned long long *data, vtkIdType length, int remoteProcessId, int tag)
 This method sends data to another process. More...
 
int Send (vtkDataObject *data, int remoteId, int tag)
 This method sends data to another process. More...
 
int Send (vtkDataArray *data, int remoteId, int tag)
 This method sends data 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)
 This method receives data from a corresponding send. More...
 
int Receive (short *data, vtkIdType maxlength, int remoteProcessId, int tag)
 This method receives data from a corresponding send. More...
 
int Receive (unsigned short *data, vtkIdType maxlength, int remoteProcessId, int tag)
 This method receives data from a corresponding send. More...
 
int Receive (long *data, vtkIdType maxlength, int remoteProcessId, int tag)
 This method receives data from a corresponding send. More...
 
int Receive (unsigned long *data, vtkIdType maxlength, int remoteProcessId, int tag)
 This method receives data from a corresponding send. More...
 
int Receive (char *data, vtkIdType maxlength, int remoteProcessId, int tag)
 This method receives data from a corresponding send. More...
 
int Receive (unsigned char *data, vtkIdType maxlength, int remoteProcessId, int tag)
 This method receives data from a corresponding send. More...
 
int Receive (signed char *data, vtkIdType maxlength, int remoteProcessId, int tag)
 This method receives data from a corresponding send. More...
 
int Receive (float *data, vtkIdType maxlength, int remoteProcessId, int tag)
 This method receives data from a corresponding send. More...
 
int Receive (double *data, vtkIdType maxlength, int remoteProcessId, int tag)
 This method receives data from a corresponding send. More...
 
int Receive (long long *data, vtkIdType maxLength, int remoteProcessId, int tag)
 This method receives data from a corresponding send. More...
 
int Receive (unsigned long long *data, vtkIdType maxLength, int remoteProcessId, int tag)
 This method receives data from a corresponding send. More...
 
int Receive (vtkDataObject *data, int remoteId, int tag)
 This method receives data from a corresponding send. More...
 
int Receive (vtkDataArray *data, int remoteId, int tag)
 This method receives data from a corresponding send. 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)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. More...
 
int Broadcast (short *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 short *data, vtkIdType length, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. More...
 
int Broadcast (long *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 long *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 char *data, vtkIdType length, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. More...
 
int Broadcast (char *data, vtkIdType length, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. More...
 
int Broadcast (signed char *data, vtkIdType length, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. More...
 
int Broadcast (float *data, vtkIdType length, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. More...
 
int Broadcast (double *data, vtkIdType length, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. More...
 
int Broadcast (long long *data, vtkIdType length, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. More...
 
int Broadcast (unsigned long long *data, vtkIdType length, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. More...
 
int Broadcast (vtkDataObject *data, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. More...
 
int Broadcast (vtkDataArray *data, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. More...
 
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)
 Gather collects arrays in the process with id destProcessId. More...
 
int Gather (const short *sendBuffer, short *recvBuffer, vtkIdType length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. More...
 
int Gather (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. More...
 
int Gather (const long *sendBuffer, long *recvBuffer, vtkIdType length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. More...
 
int Gather (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. More...
 
int Gather (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. More...
 
int Gather (const char *sendBuffer, char *recvBuffer, vtkIdType length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. More...
 
int Gather (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. More...
 
int Gather (const float *sendBuffer, float *recvBuffer, vtkIdType length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. More...
 
int Gather (const double *sendBuffer, double *recvBuffer, vtkIdType length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. More...
 
int Gather (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. More...
 
int Gather (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. More...
 
int Gather (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int destProcessId)
 Gather collects arrays in the process with id 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)
 GatherV is the vector variant of Gather. More...
 
int GatherV (const short *sendBuffer, short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 GatherV is the vector variant of Gather. More...
 
int GatherV (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 GatherV is the vector variant of Gather. More...
 
int GatherV (const long *sendBuffer, long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 GatherV is the vector variant of Gather. More...
 
int GatherV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 GatherV is the vector variant of Gather. More...
 
int GatherV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 GatherV is the vector variant of Gather. More...
 
int GatherV (const char *sendBuffer, char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 GatherV is the vector variant of Gather. More...
 
int GatherV (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 GatherV is the vector variant of Gather. More...
 
int GatherV (const float *sendBuffer, float *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 GatherV is the vector variant of Gather. More...
 
int GatherV (const double *sendBuffer, double *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 GatherV is the vector variant of Gather. More...
 
int GatherV (const long long *sendBuffer, long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 GatherV is the vector variant of Gather. More...
 
int GatherV (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 GatherV is the vector variant of Gather. More...
 
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)
 This special form of GatherV will automatically determine recvLengths and offsets to tightly pack the data in the recvBuffer in process order. More...
 
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)
 Scatter takes an array in the process with id srcProcessId and distributes it. More...
 
int Scatter (const short *sendBuffer, short *recvBuffer, vtkIdType length, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. More...
 
int Scatter (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. More...
 
int Scatter (const long *sendBuffer, long *recvBuffer, vtkIdType length, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. More...
 
int Scatter (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. More...
 
int Scatter (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. More...
 
int Scatter (const char *sendBuffer, char *recvBuffer, vtkIdType length, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. More...
 
int Scatter (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. More...
 
int Scatter (const float *sendBuffer, float *recvBuffer, vtkIdType length, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. More...
 
int Scatter (const double *sendBuffer, double *recvBuffer, vtkIdType length, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. More...
 
int Scatter (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. More...
 
int Scatter (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. More...
 
int Scatter (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. More...
 
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)
 ScatterV is the vector variant of Scatter. More...
 
int ScatterV (const short *sendBuffer, short *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. More...
 
int ScatterV (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. More...
 
int ScatterV (const long *sendBuffer, long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. More...
 
int ScatterV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. More...
 
int ScatterV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. More...
 
int ScatterV (const char *sendBuffer, char *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. More...
 
int ScatterV (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. More...
 
int ScatterV (const float *sendBuffer, float *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. More...
 
int ScatterV (const double *sendBuffer, double *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. More...
 
int ScatterV (const long long *sendBuffer, long long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. More...
 
int ScatterV (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. More...
 
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)
 Same as gather except that the result ends up on all processes. More...
 
int AllGather (const short *sendBuffer, short *recvBuffer, vtkIdType length)
 Same as gather except that the result ends up on all processes. More...
 
int AllGather (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length)
 Same as gather except that the result ends up on all processes. More...
 
int AllGather (const long *sendBuffer, long *recvBuffer, vtkIdType length)
 Same as gather except that the result ends up on all processes. More...
 
int AllGather (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length)
 Same as gather except that the result ends up on all processes. More...
 
int AllGather (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length)
 Same as gather except that the result ends up on all processes. More...
 
int AllGather (const char *sendBuffer, char *recvBuffer, vtkIdType length)
 Same as gather except that the result ends up on all processes. More...
 
int AllGather (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length)
 Same as gather except that the result ends up on all processes. More...
 
int AllGather (const float *sendBuffer, float *recvBuffer, vtkIdType length)
 Same as gather except that the result ends up on all processes. More...
 
int AllGather (const double *sendBuffer, double *recvBuffer, vtkIdType length)
 Same as gather except that the result ends up on all processes. More...
 
int AllGather (const long long *sendBuffer, long long *recvBuffer, vtkIdType length)
 Same as gather except that the result ends up on all processes. More...
 
int AllGather (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length)
 Same as gather except that the result ends up on all processes. More...
 
int AllGather (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer)
 Same as gather except that the result ends up on all processes. 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)
 Same as GatherV except that the result is placed in all processes. More...
 
int AllGatherV (const short *sendBuffer, short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 Same as GatherV except that the result is placed in all processes. More...
 
int AllGatherV (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 Same as GatherV except that the result is placed in all processes. More...
 
int AllGatherV (const long *sendBuffer, long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 Same as GatherV except that the result is placed in all processes. More...
 
int AllGatherV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 Same as GatherV except that the result is placed in all processes. More...
 
int AllGatherV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 Same as GatherV except that the result is placed in all processes. More...
 
int AllGatherV (const char *sendBuffer, char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 Same as GatherV except that the result is placed in all processes. More...
 
int AllGatherV (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 Same as GatherV except that the result is placed in all processes. More...
 
int AllGatherV (const float *sendBuffer, float *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 Same as GatherV except that the result is placed in all processes. More...
 
int AllGatherV (const double *sendBuffer, double *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 Same as GatherV except that the result is placed in all processes. More...
 
int AllGatherV (const long long *sendBuffer, long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 Same as GatherV except that the result is placed in all processes. More...
 
int AllGatherV (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 Same as GatherV except that the result is placed in all processes. More...
 
int AllGatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkIdType *recvLengths, vtkIdType *offsets)
 Same as GatherV except that the result is placed in all processes. 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)
 Reduce an array to the given destination process. More...
 
int Reduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, int operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, int operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, int operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, int operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, int operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
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)
 Reduce an array to the given destination process. More...
 
int Reduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkCommunicator::Operation *operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
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)
 Same as Reduce except that the result is placed in all of the processes. More...
 
int AllReduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, int operation)
 Same as Reduce except that the result is placed in all of the processes. More...
 
int AllReduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int operation)
 Same as Reduce except that the result is placed in all of the processes. More...
 
int AllReduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, int operation)
 Same as Reduce except that the result is placed in all of the processes. More...
 
int AllReduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int operation)
 Same as Reduce except that the result is placed in all of the processes. More...
 
int AllReduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int operation)
 Same as Reduce except that the result is placed in all of the processes. More...
 
int AllReduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, int operation)
 Same as Reduce except that the result is placed in all of the processes. More...
 
int AllReduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int operation)
 Same as Reduce except that the result is placed in all of the processes. More...
 
int AllReduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, int operation)
 Same as Reduce except that the result is placed in all of the processes. More...
 
int AllReduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, int operation)
 Same as Reduce except that the result is placed in all of the processes. More...
 
int AllReduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int operation)
 Same as Reduce except that the result is placed in all of the processes. More...
 
int AllReduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int operation)
 Same as Reduce except that the result is placed in all of the processes. More...
 
int AllReduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int operation)
 Same as Reduce except that the result is placed in all of the processes. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkMPIControllerNew ()
 
static int IsTypeOf (const char *type)
 
static vtkMPIControllerSafeDownCast (vtkObjectBase *o)
 
static char * ErrorString (int err)
 Given an MPI error code, return a string which contains an error message. More...
 
static const char * GetProcessorName ()
 
static void SetUseSsendForRMI (int use_send)
 When set to 1, TriggerRMI uses Ssend() instead of Send() calls. More...
 
static int GetUseSsendForRMI ()
 
- Static Public Member Functions inherited from vtkMultiProcessController
static int 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkMPIController ()
 
 ~vtkMPIController ()
 
void InitializeCommunicator (vtkMPICommunicator *comm)
 
void InitializeRMICommunicator ()
 
virtual void TriggerRMIInternal (int remoteProcessId, void *arg, int argLength, int rmiTag, bool propagate) override
 Implementation for TriggerRMI() provides subclasses an opportunity to modify the behaviour eg. More...
 
- Protected Member Functions inherited from vtkMultiProcessController
 vtkMultiProcessController ()
 
 ~vtkMultiProcessController () override
 
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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Attributes

static vtkMPICommunicatorWorldRMICommunicator
 
static int Initialized
 
static char ProcessorName []
 
static int UseSsendForRMI
 When set, TriggerRMI uses Ssend instead of Send. More...
 

Friends

class vtkMPIOutputWindow
 

Additional Inherited Members

- Protected Attributes inherited from vtkMultiProcessController
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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Process communication using MPI.

vtkMPIController is a concrete class which implements the abstract multi-process control methods defined in vtkMultiProcessController using MPI (Message Passing Interface) cf. Using MPI / Portable Parallel Programming with the Message-Passing Interface, Gropp et al, MIT Press. It also provide functionality specific to MPI and not present in vtkMultiProcessController. Before any MPI communication can occur Initialize() must be called by all processes. It is required to be called once, controllers created after this need not call Initialize(). At the end of the program Finalize() must be called by all processes.

The use of user-defined communicators are supported with the CreateSubController method. Note that a duplicate of the user defined communicator is used for internal communications (RMIs). This communicator has the same properties as the user one except that it has a new context which prevents the two communicators from interfering with each other.

See also
vtkOutputPort vtkInputPort vtkMultiProcessController vtkMPICommunicator vtkProcessGroup
Examples:
vtkMPIController (Examples)
Tests:
vtkMPIController (Tests)

Definition at line 61 of file vtkMPIController.h.

Member Typedef Documentation

Definition at line 67 of file vtkMPIController.h.

Constructor & Destructor Documentation

vtkMPIController::vtkMPIController ( )
protected
vtkMPIController::~vtkMPIController ( )
protected

Member Function Documentation

static vtkMPIController* vtkMPIController::New ( )
static
static int vtkMPIController::IsTypeOf ( const char *  type)
static
virtual int vtkMPIController::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 vtkMultiProcessController.

static vtkMPIController* vtkMPIController::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkMPIController::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkMultiProcessController.

vtkMPIController* vtkMPIController::NewInstance ( ) const
void vtkMPIController::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 vtkMultiProcessController.

virtual void vtkMPIController::Initialize ( int argc,
char ***  argv 
)
inlineoverridevirtual

This method is for setting up the processes.

It needs to be called only once during program execution. Calling it more than once will have no effect. Controllers created after this call will be initialized automatically (i.e. they will have the proper LocalProcessId and NumberOfProcesses). The addresses of argc and argv should be passed to this method otherwise command line arguments will not be correct (because usually MPI implementations add their own arguments during startup).

Definition at line 81 of file vtkMPIController.h.

virtual void vtkMPIController::Initialize ( int vtkNotUsedargc,
char ***  vtkNotUsedargv,
int  initializedExternally 
)
overridevirtual

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.

Implements vtkMultiProcessController.

virtual void vtkMPIController::Initialize ( )
virtual

Same as Initialize(0, 0, 1).

Mainly for calling from wrapped languages.

virtual void vtkMPIController::Finalize ( )
inlineoverridevirtual

This method is for cleaning up and has to be called before the end of the program if MPI was initialized with Initialize()

Implements vtkMultiProcessController.

Definition at line 97 of file vtkMPIController.h.

virtual void vtkMPIController::Finalize ( int  finalizedExternally)
overridevirtual

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.

Implements vtkMultiProcessController.

virtual void vtkMPIController::SingleMethodExecute ( )
overridevirtual

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

Implements vtkMultiProcessController.

virtual void vtkMPIController::MultipleMethodExecute ( )
overridevirtual

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

Implements vtkMultiProcessController.

virtual void vtkMPIController::CreateOutputWindow ( )
overridevirtual

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.

Implements vtkMultiProcessController.

static char* vtkMPIController::ErrorString ( int  err)
static

Given an MPI error code, return a string which contains an error message.

This string has to be freed by the user.

void vtkMPIController::SetCommunicator ( vtkMPICommunicator comm)

MPIController uses this communicator in all sends and receives.

By default, MPI_COMM_WORLD is used. THIS SHOULD ONLY BE CALLED ON THE PROCESSES INCLUDED IN THE COMMUNICATOR. FOR EXAMPLE, IF THE COMMUNICATOR CONTAINS PROCESSES 0 AND 1, INVOKING THIS METHOD ON ANY OTHER PROCESS WILL CAUSE AN MPI ERROR AND POSSIBLY LEAD TO A CRASH.

virtual vtkMPIController* vtkMPIController::CreateSubController ( vtkProcessGroup group)
overridevirtual

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 from vtkMultiProcessController.

virtual vtkMPIController* vtkMPIController::PartitionController ( int  localColor,
int  localKey 
)
overridevirtual

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 from vtkMultiProcessController.

int vtkMPIController::NoBlockSend ( const int data,
int  length,
int  remoteProcessId,
int  tag,
vtkMPICommunicator::Request req 
)
inline

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

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

Definition at line 152 of file vtkMPIController.h.

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

Definition at line 156 of file vtkMPIController.h.

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

Definition at line 160 of file vtkMPIController.h.

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

Definition at line 164 of file vtkMPIController.h.

int vtkMPIController::NoBlockSend ( const float data,
int  length,
int  remoteProcessId,
int  tag,
vtkMPICommunicator::Request req 
)
inline

Definition at line 168 of file vtkMPIController.h.

int vtkMPIController::NoBlockSend ( const double data,
int  length,
int  remoteProcessId,
int  tag,
vtkMPICommunicator::Request req 
)
inline

Definition at line 172 of file vtkMPIController.h.

int vtkMPIController::NoBlockReceive ( int data,
int  length,
int  remoteProcessId,
int  tag,
vtkMPICommunicator::Request req 
)
inline

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

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

Definition at line 191 of file vtkMPIController.h.

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

Definition at line 195 of file vtkMPIController.h.

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

Definition at line 200 of file vtkMPIController.h.

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

Definition at line 204 of file vtkMPIController.h.

int vtkMPIController::NoBlockReceive ( float data,
int  length,
int  remoteProcessId,
int  tag,
vtkMPICommunicator::Request req 
)
inline

Definition at line 208 of file vtkMPIController.h.

int vtkMPIController::NoBlockReceive ( double data,
int  length,
int  remoteProcessId,
int  tag,
vtkMPICommunicator::Request req 
)
inline

Definition at line 212 of file vtkMPIController.h.

int vtkMPIController::Iprobe ( int  source,
int  tag,
int flag,
int actualSource 
)
inline

Nonblocking test for a message.

Inputs are: source – the source rank or ANY_SOURCE; tag – the tag value. Outputs are: flag – True if a message matches; actualSource – the rank sending the message (useful if ANY_SOURCE is used) if flag is True and actualSource isn't nullptr; size – the length of the message in bytes if flag is true (only set if size isn't nullptr). The return value is 1 for success and 0 otherwise. Note: These methods delegate to the communicator

Definition at line 233 of file vtkMPIController.h.

int vtkMPIController::Iprobe ( int  source,
int  tag,
int flag,
int actualSource,
int type,
int size 
)
inline

Definition at line 236 of file vtkMPIController.h.

int vtkMPIController::Iprobe ( int  source,
int  tag,
int flag,
int actualSource,
unsigned long *  type,
int size 
)
inline

Definition at line 240 of file vtkMPIController.h.

int vtkMPIController::Iprobe ( int  source,
int  tag,
int flag,
int actualSource,
const char *  type,
int size 
)
inline

Definition at line 244 of file vtkMPIController.h.

int vtkMPIController::Iprobe ( int  source,
int  tag,
int flag,
int actualSource,
float type,
int size 
)
inline

Definition at line 248 of file vtkMPIController.h.

int vtkMPIController::Iprobe ( int  source,
int  tag,
int flag,
int actualSource,
double type,
int size 
)
inline

Definition at line 252 of file vtkMPIController.h.

int vtkMPIController::WaitAll ( const int  count,
vtkMPICommunicator::Request  requests[] 
)
inline

Given the request objects of a set of non-blocking operations (send and/or receive) this method blocks until all requests are complete.

Note: This method delegates to the communicator

Definition at line 262 of file vtkMPIController.h.

int vtkMPIController::WaitAny ( const int  count,
vtkMPICommunicator::Request  requests[],
int idx 
)
inline

Blocks until one of the specified requests in the given request array completes.

Upon return, the index in the array of the completed request object is returned through the argument list. Note: this method delegates to the communicator

Definition at line 271 of file vtkMPIController.h.

int vtkMPIController::WaitSome ( const int  count,
vtkMPICommunicator::Request  requests[],
vtkIntArray completed 
)

Blocks until one or more of the specified requests in the given request request array completes.

Upon return, the list of handles that have completed is stored in the completed vtkIntArray.

bool vtkMPIController::TestAll ( const int  count,
vtkMPICommunicator::Request  requests[] 
)

Returns true iff all of the communication request objects are complete.

bool vtkMPIController::TestAny ( const int  count,
vtkMPICommunicator::Request  requests[],
int idx 
)

Returns true iff at least one of the communication request objects is complete.

The index of the completed request, w.r.t. the requests array, is reflected in the out parameter idx. Otherwise, if none of the communication requests are complete false is returned.

bool vtkMPIController::TestSome ( const int  count,
vtkMPICommunicator::Request  requests[],
vtkIntArray completed 
)

Return true iff one or more of the communicator request objects is complete.

The indices of the completed requests, w.r.t. the requests array, are given in the completed user-supplied vtkIntArray.

static const char* vtkMPIController::GetProcessorName ( )
static
static void vtkMPIController::SetUseSsendForRMI ( int  use_send)
inlinestatic

When set to 1, TriggerRMI uses Ssend() instead of Send() calls.

Off (0) by default.

Definition at line 310 of file vtkMPIController.h.

static int vtkMPIController::GetUseSsendForRMI ( )
inlinestatic

Definition at line 312 of file vtkMPIController.h.

void vtkMPIController::InitializeCommunicator ( vtkMPICommunicator comm)
protected
void vtkMPIController::InitializeRMICommunicator ( )
protected
virtual void vtkMPIController::TriggerRMIInternal ( int  remoteProcessId,
void *  arg,
int  argLength,
int  rmiTag,
bool  propagate 
)
overrideprotectedvirtual

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

MPIController provides ability to use Ssend instead of Send.

Reimplemented from vtkMultiProcessController.

Friends And Related Function Documentation

friend class vtkMPIOutputWindow
friend

Definition at line 339 of file vtkMPIController.h.

Member Data Documentation

vtkMPICommunicator* vtkMPIController::WorldRMICommunicator
staticprotected

Definition at line 337 of file vtkMPIController.h.

int vtkMPIController::Initialized
staticprotected

Definition at line 342 of file vtkMPIController.h.

char vtkMPIController::ProcessorName[]
staticprotected

Definition at line 344 of file vtkMPIController.h.

int vtkMPIController::UseSsendForRMI
staticprotected

When set, TriggerRMI uses Ssend instead of Send.

Definition at line 349 of file vtkMPIController.h.


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