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

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

#include <vtkMPICommunicator.h>

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

Classes

class  Request

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
int Initialize (vtkProcessGroup *group)
int SplitInitialize (vtkCommunicator *oldcomm, int color, int key)
vtkMPICommunicatorOpaqueComm * GetMPIComm ()
virtual int SendVoidArray (const void *data, vtkIdType length, int type, int remoteProcessId, int tag)
virtual int ReceiveVoidArray (void *data, vtkIdType length, int type, int remoteProcessId, int tag)
int NoBlockSend (const int *data, int length, int remoteProcessId, int tag, Request &req)
int NoBlockSend (const unsigned long *data, int length, int remoteProcessId, int tag, Request &req)
int NoBlockSend (const char *data, int length, int remoteProcessId, int tag, Request &req)
int NoBlockSend (const float *data, int length, int remoteProcessId, int tag, Request &req)
int NoBlockReceive (int *data, int length, int remoteProcessId, int tag, Request &req)
int NoBlockReceive (unsigned long *data, int length, int remoteProcessId, int tag, Request &req)
int NoBlockReceive (char *data, int length, int remoteProcessId, int tag, Request &req)
int NoBlockReceive (float *data, int length, int remoteProcessId, int tag, Request &req)
virtual void Barrier ()
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 void SetUseSsend (int)
virtual int GetUseSsend ()
virtual void UseSsendOn ()
virtual void UseSsendOff ()
- Public Member Functions inherited from vtkCommunicator
int Receive (vtkDataObject *data, int remoteHandle, int tag)
vtkDataObjectReceiveDataObject (int remoteHandle, int tag)
int Receive (vtkDataArray *data, int remoteHandle, int tag)
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)
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)
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 ComputeGlobalBounds (int processorId, int numProcesses, vtkBoundingBox *bounds, int *rightHasBounds=0, int *leftHasBounds=0, int hasBoundsTag=288402, int localBoundsTag=288403, int globalBoundsTag=288404)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
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)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkMPICommunicatorSafeDownCast (vtkObject *o)
static vtkMPICommunicatorNew ()
static vtkMPICommunicatorGetWorldCommunicator ()
static char * Allocate (size_t size)
static void Free (char *ptr)
- Static Public Member Functions inherited from vtkCommunicator
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)
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

int InitializeNumberOfProcesses ()
void InitializeCopy (vtkMPICommunicator *source)
void Duplicate (vtkMPICommunicator *source)
virtual void SetKeepHandle (int)
virtual void KeepHandleOn ()
virtual void KeepHandleOff ()
virtual int ReceiveDataInternal (char *data, int length, int sizeoftype, int remoteProcessId, int tag, vtkMPICommunicatorReceiveDataInfo *info, int useCopy, int &senderId)
- Protected Member Functions inherited from vtkCommunicator
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 SendTemporalDataSet (vtkTemporalDataSet *data, int remoteHandle, int tag)
int ReceiveDataObject (vtkDataObject *data, int remoteHandle, int tag, int type=-1)
int ReceiveElementalDataObject (vtkDataObject *data, int remoteHandle, int tag)
int ReceiveMultiBlockDataSet (vtkMultiBlockDataSet *data, int remoteHandle, int tag)
int ReceiveTemporalDataSet (vtkTemporalDataSet *data, int remoteHandle, int tag)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Static Protected Member Functions

static int CheckForMPIError (int err)

Protected Attributes

vtkMPICommunicatorOpaqueComm * MPIComm
int Initialized
int KeepHandle
int LastSenderId
int UseSsend
- Protected Attributes inherited from vtkCommunicator
int MaximumNumberOfProcesses
int NumberOfProcesses
int LocalProcessId
vtkIdType Count
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Static Protected Attributes

static vtkMPICommunicatorWorldCommunicator
- Static Protected Attributes inherited from vtkCommunicator
static int UseCopy

Friends

class vtkMPIController
void CopyFrom (vtkMPICommunicator *source)
 vtkMPICommunicator ()
 ~vtkMPICommunicator ()

Detailed Description

Class for creating user defined MPI communicators.

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

See Also
vtkMPIController vtkProcessGroup
Tests:
vtkMPICommunicator (Tests)

Definition at line 50 of file vtkMPICommunicator.h.

Member Typedef Documentation

Definition at line 70 of file vtkMPICommunicator.h.

Constructor & Destructor Documentation

vtkMPICommunicator::vtkMPICommunicator ( )
protected

Copies all the attributes of source, deleting previously stored data. The MPI communicator handle is also copied. Normally, this should not be needed. It is used during the construction of a new communicator for copying the world communicator, keeping the same context.

vtkMPICommunicator::~vtkMPICommunicator ( )
protected

Copies all the attributes of source, deleting previously stored data. The MPI communicator handle is also copied. Normally, this should not be needed. It is used during the construction of a new communicator for copying the world communicator, keeping the same context.

Member Function Documentation

virtual const char* vtkMPICommunicator::GetClassName ( )
virtual

Reimplemented from vtkCommunicator.

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

virtual int vtkMPICommunicator::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCommunicator.

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

Reimplemented from vtkCommunicator.

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

static vtkMPICommunicator* vtkMPICommunicator::New ( )
static

Creates an empty communicator.

Reimplemented from vtkObject.

static vtkMPICommunicator* vtkMPICommunicator::GetWorldCommunicator ( )
static

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

int vtkMPICommunicator::Initialize ( vtkProcessGroup group)

Used to initialize the communicator (i.e. create the underlying MPI_Comm). The group must be associated with a valid vtkMPICommunicator.

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

Used to initialize the communicator (i.e. create the underlying MPI_Comm) using MPI_Comm_split on the given communicator.

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

Performs the actual communication. You will usually use the convenience Send functions defined in the superclass.

Implements vtkCommunicator.

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

Performs the actual communication. You will usually use the convenience Send functions defined in the superclass.

Implements vtkCommunicator.

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

This method sends data to another process (non-blocking). Tag eliminates ambiguity when multiple sends or receives exist in the same process. The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message.

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

This method sends data to another process (non-blocking). Tag eliminates ambiguity when multiple sends or receives exist in the same process. The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message.

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

This method sends data to another process (non-blocking). Tag eliminates ambiguity when multiple sends or receives exist in the same process. The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message.

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

This method sends data to another process (non-blocking). Tag eliminates ambiguity when multiple sends or receives exist in the same process. The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message.

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

This method receives data from a corresponding send (non-blocking). The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message.

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

This method receives data from a corresponding send (non-blocking). The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message.

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

This method receives data from a corresponding send (non-blocking). The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message.

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

This method receives data from a corresponding send (non-blocking). The last argument, vtkMPICommunicator::Request& req can later be used (with req.Test() ) to test the success of the message.

virtual void vtkMPICommunicator::Barrier ( )
virtual

More efficient implementations of collective operations that use the equivalent MPI commands.

Reimplemented from vtkCommunicator.

virtual int vtkMPICommunicator::BroadcastVoidArray ( void *  data,
vtkIdType  length,
int  type,
int  srcProcessId 
)
virtual

More efficient implementations of collective operations that use the equivalent MPI commands.

Reimplemented from vtkCommunicator.

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

More efficient implementations of collective operations that use the equivalent MPI commands.

Reimplemented from vtkCommunicator.

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

More efficient implementations of collective operations that use the equivalent MPI commands.

Reimplemented from vtkCommunicator.

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

More efficient implementations of collective operations that use the equivalent MPI commands.

Reimplemented from vtkCommunicator.

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

More efficient implementations of collective operations that use the equivalent MPI commands.

Reimplemented from vtkCommunicator.

virtual int vtkMPICommunicator::AllGatherVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type 
)
virtual

More efficient implementations of collective operations that use the equivalent MPI commands.

Reimplemented from vtkCommunicator.

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

More efficient implementations of collective operations that use the equivalent MPI commands.

Reimplemented from vtkCommunicator.

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

More efficient implementations of collective operations that use the equivalent MPI commands.

Reimplemented from vtkCommunicator.

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

More efficient implementations of collective operations that use the equivalent MPI commands.

Reimplemented from vtkCommunicator.

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

More efficient implementations of collective operations that use the equivalent MPI commands.

Reimplemented from vtkCommunicator.

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

More efficient implementations of collective operations that use the equivalent MPI commands.

Reimplemented from vtkCommunicator.

vtkMPICommunicatorOpaqueComm* vtkMPICommunicator::GetMPIComm ( )
inline

Definition at line 173 of file vtkMPICommunicator.h.

static char* vtkMPICommunicator::Allocate ( size_t  size)
static
static void vtkMPICommunicator::Free ( char *  ptr)
static
virtual void vtkMPICommunicator::SetUseSsend ( int  )
virtual

When set to 1, all MPI_Send calls are replaced by MPI_Ssend calls. Default is 0.

virtual int vtkMPICommunicator::GetUseSsend ( )
virtual

When set to 1, all MPI_Send calls are replaced by MPI_Ssend calls. Default is 0.

virtual void vtkMPICommunicator::UseSsendOn ( )
virtual

When set to 1, all MPI_Send calls are replaced by MPI_Ssend calls. Default is 0.

virtual void vtkMPICommunicator::UseSsendOff ( )
virtual

When set to 1, all MPI_Send calls are replaced by MPI_Ssend calls. Default is 0.

void vtkMPICommunicator::CopyFrom ( vtkMPICommunicator source)

Copies all the attributes of source, deleting previously stored data. The MPI communicator handle is also copied. Normally, this should not be needed. It is used during the construction of a new communicator for copying the world communicator, keeping the same context.

int vtkMPICommunicator::InitializeNumberOfProcesses ( )
protected
virtual void vtkMPICommunicator::SetKeepHandle ( int  )
protectedvirtual

KeepHandle is normally off. This means that the MPI communicator handle will be freed at the destruction of the object. However, if the handle was copied from another object (via CopyFrom() not Duplicate()), this has to be turned on otherwise the handle will be freed multiple times causing MPI failure. The alternative to this is using reference counting but it is unnecessarily complicated for this case.

virtual void vtkMPICommunicator::KeepHandleOn ( )
protectedvirtual

KeepHandle is normally off. This means that the MPI communicator handle will be freed at the destruction of the object. However, if the handle was copied from another object (via CopyFrom() not Duplicate()), this has to be turned on otherwise the handle will be freed multiple times causing MPI failure. The alternative to this is using reference counting but it is unnecessarily complicated for this case.

virtual void vtkMPICommunicator::KeepHandleOff ( )
protectedvirtual

KeepHandle is normally off. This means that the MPI communicator handle will be freed at the destruction of the object. However, if the handle was copied from another object (via CopyFrom() not Duplicate()), this has to be turned on otherwise the handle will be freed multiple times causing MPI failure. The alternative to this is using reference counting but it is unnecessarily complicated for this case.

void vtkMPICommunicator::InitializeCopy ( vtkMPICommunicator source)
protected
void vtkMPICommunicator::Duplicate ( vtkMPICommunicator source)
protected

Copies all the attributes of source, deleting previously stored data EXCEPT the MPI communicator handle which is duplicated with MPI_Comm_dup(). Therefore, although the processes in the communicator remain the same, a new context is created. This prevents the two communicators from intefering with each other during message send/receives even if the tags are the same.

virtual int vtkMPICommunicator::ReceiveDataInternal ( char *  data,
int  length,
int  sizeoftype,
int  remoteProcessId,
int  tag,
vtkMPICommunicatorReceiveDataInfo *  info,
int  useCopy,
int &  senderId 
)
protectedvirtual

Implementation for receive data.

static int vtkMPICommunicator::CheckForMPIError ( int  err)
staticprotected

Friends And Related Function Documentation

friend class vtkMPIController
friend

Definition at line 171 of file vtkMPICommunicator.h.

Member Data Documentation

vtkMPICommunicator* vtkMPICommunicator::WorldCommunicator
staticprotected

Definition at line 215 of file vtkMPICommunicator.h.

vtkMPICommunicatorOpaqueComm* vtkMPICommunicator::MPIComm
protected

Definition at line 240 of file vtkMPICommunicator.h.

int vtkMPICommunicator::Initialized
protected

Definition at line 242 of file vtkMPICommunicator.h.

int vtkMPICommunicator::KeepHandle
protected

Definition at line 243 of file vtkMPICommunicator.h.

int vtkMPICommunicator::LastSenderId
protected

Definition at line 245 of file vtkMPICommunicator.h.

int vtkMPICommunicator::UseSsend
protected

Definition at line 246 of file vtkMPICommunicator.h.


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