VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
vtkCommunicator Class Reference

Used to send/receive messages in a multiprocess environment. More...

#include <vtkCommunicator.h>

Inheritance diagram for vtkCommunicator:
Inheritance graph
[legend]
Collaboration diagram for vtkCommunicator:
Collaboration graph
[legend]

List of all members.

Classes

class  Operation

Public Types

enum  Tags {
  BROADCAST_TAG = 10, GATHER_TAG = 11, GATHERV_TAG = 12, SCATTER_TAG = 13,
  SCATTERV_TAG = 14, REDUCE_TAG = 15, BARRIER_TAG = 16
}
enum  StandardOperations {
  MAX_OP, MIN_OP, SUM_OP, PRODUCT_OP,
  LOGICAL_AND_OP, BITWISE_AND_OP, LOGICAL_OR_OP, BITWISE_OR_OP,
  LOGICAL_XOR_OP, BITWISE_XOR_OP
}
typedef vtkObject Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkCommunicatorNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
int Receive (vtkDataObject *data, int remoteHandle, int tag)
vtkDataObjectReceiveDataObject (int remoteHandle, int tag)
int Receive (vtkDataArray *data, int remoteHandle, int tag)
virtual void Barrier ()
virtual void SetNumberOfProcesses (int num)
virtual int GetNumberOfProcesses ()
virtual int GetLocalProcessId ()
int Send (vtkDataObject *data, int remoteHandle, int tag)
int Send (vtkDataArray *data, int remoteHandle, int tag)
virtual int SendVoidArray (const void *data, vtkIdType length, int type, int remoteHandle, int tag)=0
int Send (const int *data, vtkIdType length, int remoteHandle, int tag)
int Send (const unsigned int *data, vtkIdType length, int remoteHandle, int tag)
int Send (const unsigned long *data, vtkIdType length, int remoteHandle, int tag)
int Send (const unsigned char *data, vtkIdType length, int remoteHandle, int tag)
int Send (const char *data, vtkIdType length, int remoteHandle, int tag)
int Send (const float *data, vtkIdType length, int remoteHandle, int tag)
int Send (const double *data, vtkIdType length, int remoteHandle, int tag)
int Send (const vtkMultiProcessStream &stream, int remoteId, int tag)
virtual int ReceiveVoidArray (void *data, vtkIdType maxlength, int type, int remoteHandle, int tag)=0
int Receive (int *data, vtkIdType maxlength, int remoteHandle, int tag)
int Receive (unsigned int *data, vtkIdType maxlength, int remoteHandle, int tag)
int Receive (unsigned long *data, vtkIdType maxlength, int remoteHandle, int tag)
int Receive (unsigned char *data, vtkIdType maxlength, int remoteHandle, int tag)
int Receive (char *data, vtkIdType maxlength, int remoteHandle, int tag)
int Receive (float *data, vtkIdType maxlength, int remoteHandle, int tag)
int Receive (double *data, vtkIdType maxlength, int remoteHandle, int tag)
int Receive (vtkMultiProcessStream &stream, int remoteId, int tag)
virtual vtkIdType GetCount ()
int Broadcast (int *data, vtkIdType length, int srcProcessId)
int Broadcast (unsigned int *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 (float *data, vtkIdType length, int srcProcessId)
int Broadcast (double *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)
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 float *sendBuffer, float *recvBuffer, vtkIdType length, int destProcessId)
int Gather (const double *sendBuffer, double *recvBuffer, vtkIdType length, int destProcessId)
int Gather (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int destProcessId)
int GatherV (const int *sendBuffer, int *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 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 (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
int GatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int destProcessId)
int Scatter (const int *sendBuffer, int *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 float *sendBuffer, float *recvBuffer, vtkIdType length, int srcProcessId)
int Scatter (const double *sendBuffer, double *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)
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 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 AllGather (const int *sendBuffer, int *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 float *sendBuffer, float *recvBuffer, vtkIdType length)
int AllGather (const double *sendBuffer, double *recvBuffer, vtkIdType length)
int AllGather (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer)
int AllGatherV (const int *sendBuffer, int *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 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 (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkIdType *recvLengths, vtkIdType *offsets)
int AllGatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer)
int Reduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, int operation, int destProcessId)
int Reduce (const unsigned int *sendBuffer, unsigned int *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 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 (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int operation, int destProcessId)
int Reduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
int Reduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
int Reduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
int Reduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
int Reduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
int Reduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
int Reduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, Operation *operation, int destProcessId)
int AllReduce (const int *sendBuffer, int *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 float *sendBuffer, float *recvBuffer, vtkIdType length, int operation)
int AllReduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, int operation)
int AllReduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int operation)
int AllReduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, Operation *operation)
int AllReduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, Operation *operation)
int AllReduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, Operation *operation)
int AllReduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, Operation *operation)
int AllReduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, Operation *operation)
int AllReduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, Operation *operation)
int AllReduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, Operation *operation)
virtual int BroadcastVoidArray (void *data, vtkIdType length, int type, int srcProcessId)
virtual int GatherVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, int destProcessId)
virtual int GatherVVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int type, int destProcessId)
virtual int ScatterVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, int srcProcessId)
virtual int ScatterVVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int type, int srcProcessId)
virtual int AllGatherVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType length, int type)
virtual int AllGatherVVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int type)
virtual int ReduceVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, int operation, int destProcessId)
virtual int ReduceVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, Operation *operation, int destProcessId)
virtual int AllReduceVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, int operation)
virtual int AllReduceVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, Operation *operation)
virtual int ComputeGlobalBounds (int processorId, int numProcesses, vtkBoundingBox *bounds, int *rightHasBounds=0, int *leftHasBounds=0, int hasBoundsTag=288402, int localBoundsTag=288403, int globalBoundsTag=288404)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkCommunicatorSafeDownCast (vtkObjectBase *o)
static void SetUseCopy (int useCopy)
static int GetParentProcessor (int pid)
static int GetLeftChildProcessor (int pid)
static int MarshalDataObject (vtkDataObject *object, vtkCharArray *buffer)
static int UnMarshalDataObject (vtkCharArray *buffer, vtkDataObject *object)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
int WriteDataArray (vtkDataArray *object)
int ReadDataArray (vtkDataArray *object)
 vtkCommunicator ()
 ~vtkCommunicator ()
int SendElementalDataObject (vtkDataObject *data, int remoteHandle, int tag)
int SendMultiBlockDataSet (vtkMultiBlockDataSet *data, int remoteHandle, int tag)
int ReceiveDataObject (vtkDataObject *data, int remoteHandle, int tag, int type=-1)
int ReceiveElementalDataObject (vtkDataObject *data, int remoteHandle, int tag)
int ReceiveMultiBlockDataSet (vtkMultiBlockDataSet *data, int remoteHandle, int tag)

Protected Attributes

int MaximumNumberOfProcesses
int NumberOfProcesses
int LocalProcessId
vtkIdType Count

Static Protected Attributes

static int UseCopy

Detailed Description

Used to send/receive messages in a multiprocess environment.

This is an abstact class which contains functionality for sending and receiving inter-process messages. It contains methods for marshaling an object into a string (currently used by the MPI communicator but not the shared memory communicator).

Warning:
Communication between systems with different vtkIdTypes is not supported. All machines have to have the same vtkIdType.
See also:
vtkMPICommunicator
Tests:
vtkCommunicator (Tests)

Definition at line 49 of file vtkCommunicator.h.


Member Typedef Documentation

Reimplemented from vtkObject.

Reimplemented in vtkMPICommunicator, vtkSocketCommunicator, vtkSubCommunicator, and vtkDummyCommunicator.

Definition at line 54 of file vtkCommunicator.h.


Member Enumeration Documentation

Enumerator:
BROADCAST_TAG 
GATHER_TAG 
GATHERV_TAG 
SCATTER_TAG 
SCATTERV_TAG 
REDUCE_TAG 
BARRIER_TAG 

Definition at line 72 of file vtkCommunicator.h.

Enumerator:
MAX_OP 
MIN_OP 
SUM_OP 
PRODUCT_OP 
LOGICAL_AND_OP 
BITWISE_AND_OP 
LOGICAL_OR_OP 
BITWISE_OR_OP 
LOGICAL_XOR_OP 
BITWISE_XOR_OP 

Definition at line 83 of file vtkCommunicator.h.


Constructor & Destructor Documentation


Member Function Documentation

static int vtkCommunicator::IsTypeOf ( const char *  name) [static]

Return 1 if this class type 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 vtkObject.

Reimplemented in vtkMPICommunicator, vtkSocketCommunicator, vtkSubCommunicator, and vtkDummyCommunicator.

virtual int vtkCommunicator::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 vtkObject.

Reimplemented in vtkMPICommunicator, vtkSocketCommunicator, vtkSubCommunicator, and vtkDummyCommunicator.

virtual vtkObjectBase* vtkCommunicator::NewInstanceInternal ( ) const [protected, virtual]
void vtkCommunicator::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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 vtkMPICommunicator, vtkSocketCommunicator, vtkSubCommunicator, and vtkDummyCommunicator.

virtual void vtkCommunicator::SetNumberOfProcesses ( int  num) [virtual]

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.

Reimplemented in vtkSocketCommunicator.

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.

virtual int vtkCommunicator::GetLocalProcessId ( ) [virtual]

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

int vtkCommunicator::Send ( vtkDataObject data,
int  remoteHandle,
int  tag 
)

This method sends a data object to a destination. Tag eliminates ambiguity and is used to match sends to receives.

int vtkCommunicator::Send ( vtkDataArray data,
int  remoteHandle,
int  tag 
)

This method sends a data array to a destination. Tag eliminates ambiguity and is used to match sends to receives.

virtual int vtkCommunicator::SendVoidArray ( const void *  data,
vtkIdType  length,
int  type,
int  remoteHandle,
int  tag 
) [pure virtual]

Subclasses have to supply this method to send various arrays of data. The type arg is one of the VTK type constants recognized by the vtkTemplateMacro (VTK_FLOAT, VTK_INT, etc.). length is measured in number of values (as opposed to number of bytes).

Implemented in vtkSocketCommunicator, vtkMPICommunicator, vtkSubCommunicator, and vtkDummyCommunicator.

int vtkCommunicator::Send ( const int data,
vtkIdType  length,
int  remoteHandle,
int  tag 
) [inline]

Convenience methods for sending data arrays.

Definition at line 146 of file vtkCommunicator.h.

int vtkCommunicator::Send ( const unsigned int data,
vtkIdType  length,
int  remoteHandle,
int  tag 
) [inline]

Convenience methods for sending data arrays.

Definition at line 149 of file vtkCommunicator.h.

int vtkCommunicator::Send ( const unsigned long *  data,
vtkIdType  length,
int  remoteHandle,
int  tag 
) [inline]

Convenience methods for sending data arrays.

Definition at line 152 of file vtkCommunicator.h.

int vtkCommunicator::Send ( const unsigned char *  data,
vtkIdType  length,
int  remoteHandle,
int  tag 
) [inline]

Convenience methods for sending data arrays.

Definition at line 156 of file vtkCommunicator.h.

int vtkCommunicator::Send ( const char *  data,
vtkIdType  length,
int  remoteHandle,
int  tag 
) [inline]

Convenience methods for sending data arrays.

Definition at line 160 of file vtkCommunicator.h.

int vtkCommunicator::Send ( const float data,
vtkIdType  length,
int  remoteHandle,
int  tag 
) [inline]

Convenience methods for sending data arrays.

Definition at line 163 of file vtkCommunicator.h.

int vtkCommunicator::Send ( const double data,
vtkIdType  length,
int  remoteHandle,
int  tag 
) [inline]

Convenience methods for sending data arrays.

Definition at line 166 of file vtkCommunicator.h.

int vtkCommunicator::Send ( const vtkMultiProcessStream stream,
int  remoteId,
int  tag 
)

Convenience methods for sending data arrays.

int vtkCommunicator::Receive ( vtkDataObject data,
int  remoteHandle,
int  tag 
)

This method receives a data object from a corresponding send. It blocks until the receive is finished.

The caller does not have to know the data type before this call is made. It returns the newly created object.

int vtkCommunicator::Receive ( vtkDataArray data,
int  remoteHandle,
int  tag 
)

This method receives a data array from a corresponding send. It blocks until the receive is finished.

virtual int vtkCommunicator::ReceiveVoidArray ( void *  data,
vtkIdType  maxlength,
int  type,
int  remoteHandle,
int  tag 
) [pure virtual]

Subclasses have to supply this method to receive various arrays of data. The type arg is one of the VTK type constants recognized by the vtkTemplateMacro (VTK_FLOAT, VTK_INT, etc.). maxlength is measured in number of values (as opposed to number of bytes) and is the maxmum length of the data 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.

Implemented in vtkSocketCommunicator, vtkMPICommunicator, vtkSubCommunicator, and vtkDummyCommunicator.

int vtkCommunicator::Receive ( int data,
vtkIdType  maxlength,
int  remoteHandle,
int  tag 
) [inline]

Convenience methods for receiving data arrays.

Definition at line 207 of file vtkCommunicator.h.

int vtkCommunicator::Receive ( unsigned int data,
vtkIdType  maxlength,
int  remoteHandle,
int  tag 
) [inline]

Convenience methods for receiving data arrays.

Definition at line 210 of file vtkCommunicator.h.

int vtkCommunicator::Receive ( unsigned long *  data,
vtkIdType  maxlength,
int  remoteHandle,
int  tag 
) [inline]

Convenience methods for receiving data arrays.

Definition at line 213 of file vtkCommunicator.h.

int vtkCommunicator::Receive ( unsigned char *  data,
vtkIdType  maxlength,
int  remoteHandle,
int  tag 
) [inline]

Convenience methods for receiving data arrays.

Definition at line 217 of file vtkCommunicator.h.

int vtkCommunicator::Receive ( char *  data,
vtkIdType  maxlength,
int  remoteHandle,
int  tag 
) [inline]

Convenience methods for receiving data arrays.

Definition at line 221 of file vtkCommunicator.h.

int vtkCommunicator::Receive ( float data,
vtkIdType  maxlength,
int  remoteHandle,
int  tag 
) [inline]

Convenience methods for receiving data arrays.

Definition at line 224 of file vtkCommunicator.h.

int vtkCommunicator::Receive ( double data,
vtkIdType  maxlength,
int  remoteHandle,
int  tag 
) [inline]

Convenience methods for receiving data arrays.

Definition at line 227 of file vtkCommunicator.h.

int vtkCommunicator::Receive ( vtkMultiProcessStream stream,
int  remoteId,
int  tag 
)

Convenience methods for receiving data arrays.

virtual vtkIdType vtkCommunicator::GetCount ( ) [virtual]

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

virtual void vtkCommunicator::Barrier ( ) [virtual]

Will block the processes until all other processes reach the Barrier function.

Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

int vtkCommunicator::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 261 of file vtkCommunicator.h.

int vtkCommunicator::Broadcast ( unsigned 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 264 of file vtkCommunicator.h.

int vtkCommunicator::Broadcast ( unsigned long *  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 267 of file vtkCommunicator.h.

int vtkCommunicator::Broadcast ( unsigned char *  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 270 of file vtkCommunicator.h.

int vtkCommunicator::Broadcast ( char *  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 273 of file vtkCommunicator.h.

int vtkCommunicator::Broadcast ( float 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 276 of file vtkCommunicator.h.

int vtkCommunicator::Broadcast ( double 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 279 of file vtkCommunicator.h.

int vtkCommunicator::Broadcast ( vtkDataObject data,
int  srcProcessId 
)

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.

int vtkCommunicator::Broadcast ( vtkDataArray data,
int  srcProcessId 
)

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.

int vtkCommunicator::Broadcast ( vtkMultiProcessStream stream,
int  srcProcessId 
)

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.

int vtkCommunicator::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 te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

Definition at line 303 of file vtkCommunicator.h.

int vtkCommunicator::Gather ( const unsigned long *  sendBuffer,
unsigned long *  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 te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

Definition at line 308 of file vtkCommunicator.h.

int vtkCommunicator::Gather ( const unsigned char *  sendBuffer,
unsigned char *  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 te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

Definition at line 313 of file vtkCommunicator.h.

int vtkCommunicator::Gather ( const char *  sendBuffer,
char *  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 te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

Definition at line 318 of file vtkCommunicator.h.

int vtkCommunicator::Gather ( const float sendBuffer,
float 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 te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

Definition at line 323 of file vtkCommunicator.h.

int vtkCommunicator::Gather ( const double sendBuffer,
double 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 te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

Definition at line 328 of file vtkCommunicator.h.

int vtkCommunicator::Gather ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer,
int  destProcessId 
)

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 te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

int vtkCommunicator::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 355 of file vtkCommunicator.h.

int vtkCommunicator::GatherV ( const unsigned long *  sendBuffer,
unsigned long *  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 362 of file vtkCommunicator.h.

int vtkCommunicator::GatherV ( const unsigned char *  sendBuffer,
unsigned char *  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 369 of file vtkCommunicator.h.

int vtkCommunicator::GatherV ( const char *  sendBuffer,
char *  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 376 of file vtkCommunicator.h.

int vtkCommunicator::GatherV ( const float sendBuffer,
float 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 383 of file vtkCommunicator.h.

int vtkCommunicator::GatherV ( const double sendBuffer,
double 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 390 of file vtkCommunicator.h.

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

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.

int vtkCommunicator::GatherV ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer,
int  destProcessId 
)

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.

int vtkCommunicator::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 418 of file vtkCommunicator.h.

int vtkCommunicator::Scatter ( const unsigned long *  sendBuffer,
unsigned long *  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 423 of file vtkCommunicator.h.

int vtkCommunicator::Scatter ( const unsigned char *  sendBuffer,
unsigned char *  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 428 of file vtkCommunicator.h.

int vtkCommunicator::Scatter ( const char *  sendBuffer,
char *  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 433 of file vtkCommunicator.h.

int vtkCommunicator::Scatter ( const float sendBuffer,
float 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 438 of file vtkCommunicator.h.

int vtkCommunicator::Scatter ( const double sendBuffer,
double 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 443 of file vtkCommunicator.h.

int vtkCommunicator::Scatter ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer,
int  srcProcessId 
)

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.

int vtkCommunicator::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 466 of file vtkCommunicator.h.

int vtkCommunicator::ScatterV ( const unsigned long *  sendBuffer,
unsigned long *  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 473 of file vtkCommunicator.h.

int vtkCommunicator::ScatterV ( const unsigned char *  sendBuffer,
unsigned char *  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 480 of file vtkCommunicator.h.

int vtkCommunicator::ScatterV ( const char *  sendBuffer,
char *  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 487 of file vtkCommunicator.h.

int vtkCommunicator::ScatterV ( const float sendBuffer,
float 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 494 of file vtkCommunicator.h.

int vtkCommunicator::ScatterV ( const double sendBuffer,
double 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 501 of file vtkCommunicator.h.

int vtkCommunicator::AllGather ( const int sendBuffer,
int recvBuffer,
vtkIdType  length 
) [inline]

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

Definition at line 521 of file vtkCommunicator.h.

int vtkCommunicator::AllGather ( const unsigned long *  sendBuffer,
unsigned long *  recvBuffer,
vtkIdType  length 
) [inline]

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

Definition at line 524 of file vtkCommunicator.h.

int vtkCommunicator::AllGather ( const unsigned char *  sendBuffer,
unsigned char *  recvBuffer,
vtkIdType  length 
) [inline]

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

Definition at line 529 of file vtkCommunicator.h.

int vtkCommunicator::AllGather ( const char *  sendBuffer,
char *  recvBuffer,
vtkIdType  length 
) [inline]

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

Definition at line 534 of file vtkCommunicator.h.

int vtkCommunicator::AllGather ( const float sendBuffer,
float recvBuffer,
vtkIdType  length 
) [inline]

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

Definition at line 537 of file vtkCommunicator.h.

int vtkCommunicator::AllGather ( const double sendBuffer,
double recvBuffer,
vtkIdType  length 
) [inline]

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

Definition at line 540 of file vtkCommunicator.h.

int vtkCommunicator::AllGather ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer 
)

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

int vtkCommunicator::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 556 of file vtkCommunicator.h.

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

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

Definition at line 563 of file vtkCommunicator.h.

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

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

Definition at line 570 of file vtkCommunicator.h.

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

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

Definition at line 577 of file vtkCommunicator.h.

int vtkCommunicator::AllGatherV ( const float sendBuffer,
float recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
) [inline]

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

Definition at line 584 of file vtkCommunicator.h.

int vtkCommunicator::AllGatherV ( const double sendBuffer,
double recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets 
) [inline]

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

Definition at line 591 of file vtkCommunicator.h.

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

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

int vtkCommunicator::AllGatherV ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer 
)

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

int vtkCommunicator::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 616 of file vtkCommunicator.h.

int vtkCommunicator::Reduce ( const unsigned int sendBuffer,
unsigned 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 621 of file vtkCommunicator.h.

int vtkCommunicator::Reduce ( const unsigned long *  sendBuffer,
unsigned long *  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 626 of file vtkCommunicator.h.

int vtkCommunicator::Reduce ( const unsigned char *  sendBuffer,
unsigned char *  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 631 of file vtkCommunicator.h.

int vtkCommunicator::Reduce ( const char *  sendBuffer,
char *  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 636 of file vtkCommunicator.h.

int vtkCommunicator::Reduce ( const float sendBuffer,
float 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 641 of file vtkCommunicator.h.

int vtkCommunicator::Reduce ( const double sendBuffer,
double 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 646 of file vtkCommunicator.h.

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

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.

int vtkCommunicator::Reduce ( const int sendBuffer,
int recvBuffer,
vtkIdType  length,
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 666 of file vtkCommunicator.h.

int vtkCommunicator::Reduce ( const unsigned long *  sendBuffer,
unsigned long *  recvBuffer,
vtkIdType  length,
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 671 of file vtkCommunicator.h.

int vtkCommunicator::Reduce ( const unsigned char *  sendBuffer,
unsigned char *  recvBuffer,
vtkIdType  length,
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 676 of file vtkCommunicator.h.

int vtkCommunicator::Reduce ( const char *  sendBuffer,
char *  recvBuffer,
vtkIdType  length,
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 681 of file vtkCommunicator.h.

int vtkCommunicator::Reduce ( const float sendBuffer,
float recvBuffer,
vtkIdType  length,
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 686 of file vtkCommunicator.h.

int vtkCommunicator::Reduce ( const double sendBuffer,
double recvBuffer,
vtkIdType  length,
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 691 of file vtkCommunicator.h.

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

Reduce an array to the given destination process. This version of Reduce takes a custom operation as a subclass of vtkCommunicator::Operation.

int vtkCommunicator::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 710 of file vtkCommunicator.h.

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

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

Definition at line 715 of file vtkCommunicator.h.

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

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

Definition at line 720 of file vtkCommunicator.h.

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

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

Definition at line 725 of file vtkCommunicator.h.

int vtkCommunicator::AllReduce ( const float sendBuffer,
float recvBuffer,
vtkIdType  length,
int  operation 
) [inline]

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

Definition at line 730 of file vtkCommunicator.h.

int vtkCommunicator::AllReduce ( const double sendBuffer,
double recvBuffer,
vtkIdType  length,
int  operation 
) [inline]

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

Definition at line 735 of file vtkCommunicator.h.

int vtkCommunicator::AllReduce ( vtkDataArray sendBuffer,
vtkDataArray recvBuffer,
int  operation 
)

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

int vtkCommunicator::AllReduce ( const int sendBuffer,
int recvBuffer,
vtkIdType  length,
Operation operation 
) [inline]

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

Definition at line 749 of file vtkCommunicator.h.

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

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

Definition at line 754 of file vtkCommunicator.h.

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

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

Definition at line 759 of file vtkCommunicator.h.

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

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

Definition at line 764 of file vtkCommunicator.h.

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

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

Definition at line 769 of file vtkCommunicator.h.

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

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

Definition at line 774 of file vtkCommunicator.h.

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

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

virtual int vtkCommunicator::BroadcastVoidArray ( void *  data,
vtkIdType  length,
int  type,
int  srcProcessId 
) [virtual]

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::GatherVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type,
int  destProcessId 
) [virtual]

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::GatherVVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  type,
int  destProcessId 
) [virtual]

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::ScatterVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type,
int  srcProcessId 
) [virtual]

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::ScatterVVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  type,
int  srcProcessId 
) [virtual]

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::AllGatherVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type 
) [virtual]

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::AllGatherVVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  type 
) [virtual]

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::ReduceVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type,
int  operation,
int  destProcessId 
) [virtual]

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::ReduceVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type,
Operation operation,
int  destProcessId 
) [virtual]

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::AllReduceVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type,
int  operation 
) [virtual]

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::AllReduceVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type,
Operation operation 
) [virtual]

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

static void vtkCommunicator::SetUseCopy ( int  useCopy) [static]
virtual int vtkCommunicator::ComputeGlobalBounds ( int  processorId,
int  numProcesses,
vtkBoundingBox bounds,
int rightHasBounds = 0,
int leftHasBounds = 0,
int  hasBoundsTag = 288402,
int  localBoundsTag = 288403,
int  globalBoundsTag = 288404 
) [virtual]

Determine the global bounds for a set of processes. BBox is initially set (outside of the call to the local bounds of the process and will be modified to be the global bounds - this default implementation views the processors as a heap tree with the root being processId = 0 If either rightHasBounds or leftHasBounds is not 0 then the corresponding int will be set to 1 if the right/left processor has bounds else it will be set to 0 The last three arguments are the tags to be used when performing the operation

static int vtkCommunicator::GetParentProcessor ( int  pid) [static]

Some helper functions when dealing with heap tree - based algorthims

  • we don't need a function for getting the right processor since it is 1 + theLeftProcessor

Some helper functions when dealing with heap tree - based algorthims

  • we don't need a function for getting the right processor since it is 1 + theLeftProcessor
static int vtkCommunicator::MarshalDataObject ( vtkDataObject object,
vtkCharArray buffer 
) [static]

Convert a data object into a string that can be transmitted and vice versa. Returns 1 for success and 0 for failure. WARNING: This will only work for types that have a vtkDataWriter class.

static int vtkCommunicator::UnMarshalDataObject ( vtkCharArray buffer,
vtkDataObject object 
) [static]

Convert a data object into a string that can be transmitted and vice versa. Returns 1 for success and 0 for failure. WARNING: This will only work for types that have a vtkDataWriter class.

int vtkCommunicator::ReadDataArray ( vtkDataArray object) [protected]
int vtkCommunicator::SendElementalDataObject ( vtkDataObject data,
int  remoteHandle,
int  tag 
) [protected]
int vtkCommunicator::SendMultiBlockDataSet ( vtkMultiBlockDataSet data,
int  remoteHandle,
int  tag 
) [protected]
int vtkCommunicator::ReceiveDataObject ( vtkDataObject data,
int  remoteHandle,
int  tag,
int  type = -1 
) [protected]
int vtkCommunicator::ReceiveElementalDataObject ( vtkDataObject data,
int  remoteHandle,
int  tag 
) [protected]
int vtkCommunicator::ReceiveMultiBlockDataSet ( vtkMultiBlockDataSet data,
int  remoteHandle,
int  tag 
) [protected]

Member Data Documentation

Definition at line 881 of file vtkCommunicator.h.

Definition at line 882 of file vtkCommunicator.h.

Definition at line 884 of file vtkCommunicator.h.

int vtkCommunicator::UseCopy [static, protected]

Definition at line 886 of file vtkCommunicator.h.

Definition at line 888 of file vtkCommunicator.h.


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