Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkMPICommunicator Class Reference

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

#include <vtkMPICommunicator.h>

Inheritance diagram for vtkMPICommunicator:

Inheritance graph
[legend]
Collaboration diagram for vtkMPICommunicator:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
int Initialize (vtkMPICommunicator *mpiComm, vtkMPIGroup *group)
virtual int Send (int *data, int length, int remoteProcessId, int tag)
virtual int Send (unsigned long *data, int length, int remoteProcessId, int tag)
virtual int Send (char *data, int length, int remoteProcessId, int tag)
virtual int Send (unsigned char *data, int length, int remoteProcessId, int tag)
virtual int Send (float *data, int length, int remoteProcessId, int tag)
virtual int Send (double *data, int length, int remoteProcessId, int tag)
virtual int Send (vtkDataObject *data, int remoteProcessId, int tag)
virtual int Send (vtkDataArray *data, int remoteProcessId, int tag)
int NoBlockSend (int *data, int length, int remoteProcessId, int tag, Request &req)
int NoBlockSend (unsigned long *data, int length, int remoteProcessId, int tag, Request &req)
int NoBlockSend (char *data, int length, int remoteProcessId, int tag, Request &req)
int NoBlockSend (float *data, int length, int remoteProcessId, int tag, Request &req)
virtual int Receive (int *data, int length, int remoteProcessId, int tag)
virtual int Receive (unsigned long *data, int length, int remoteProcessId, int tag)
virtual int Receive (char *data, int length, int remoteProcessId, int tag)
virtual int Receive (unsigned char *data, int length, int remoteProcessId, int tag)
virtual int Receive (float *data, int length, int remoteProcessId, int tag)
virtual int Receive (double *data, int length, int remoteProcessId, int tag)
virtual int Receive (vtkDataObject *data, int remoteProcessId, int tag)
virtual int Receive (vtkDataArray *data, int remoteProcessId, int tag)
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)

Static Public Methods

int IsTypeOf (const char *type)
vtkMPICommunicator * SafeDownCast (vtkObject *o)
vtkMPICommunicator * New ()
vtkMPICommunicator * GetWorldCommunicator ()

Protected Methods

virtual void SetGroup (vtkMPIGroup *)
void InitializeCopy (vtkMPICommunicator *source)
void CopyFrom (vtkMPICommunicator *source)
void Duplicate (vtkMPICommunicator *source)
 vtkMPICommunicator ()
 ~vtkMPICommunicator ()
virtual void SetKeepHandle (int)
virtual void KeepHandleOn ()
virtual void KeepHandleOff ()

Protected Attributes

MPI_Comm * Handle
vtkMPIGroup * Group
int Initialized
int KeepHandle

Static Protected Attributes

vtkMPICommunicator * WorldCommunicator

Friends

class vtkMPIController

Detailed Description

Class for creating user defined MPI communicators.

Date:
2001/11/13 14:25:57
Revision:
1.14

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 vtkMPIGroup
Tests:
vtkMPICommunicator (Tests)

Definition at line 75 of file vtkMPICommunicator.h.

Constructor & Destructor Documentation

vtkMPICommunicator::vtkMPICommunicator (    )  [protected]
 

vtkMPICommunicator::~vtkMPICommunicator (    )  [protected]
 

Member Function Documentation

virtual const char* vtkMPICommunicator::GetClassName (    )  [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCommunicator.

int vtkMPICommunicator::IsTypeOf (  const char *    type )  [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 *    type )  [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.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCommunicator.

vtkMPICommunicator* vtkMPICommunicator::New (    )  [static]
 

Creates an empty communicator.

Reimplemented from vtkObject.

vtkMPICommunicator* vtkMPICommunicator::GetWorldCommunicator (    )  [static]
 

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

virtual 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.

int vtkMPICommunicator::Initialize (  vtkMPICommunicator *    mpiComm,
vtkMPIGroup *    group
) 
 

Used to initialize (i.e. create the underlying MPI_Comm) the communicator. Note that group is also stored in an instance variable (the reference count of group is increased by 1). group->Delete() can be safely invoked after this.

virtual int vtkMPICommunicator::Send (  int *    data,
int    length,
int    remoteProcessId,
int    tag
)  [virtual]
 

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

Reimplemented from vtkCommunicator.

virtual int vtkMPICommunicator::Send (  unsigned long *    data,
int    length,
int    remoteProcessId,
int    tag
)  [virtual]
 

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

Reimplemented from vtkCommunicator.

virtual int vtkMPICommunicator::Send (  char *    data,
int    length,
int    remoteProcessId,
int    tag
)  [virtual]
 

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

Reimplemented from vtkCommunicator.

virtual int vtkMPICommunicator::Send (  unsigned char *    data,
int    length,
int    remoteProcessId,
int    tag
)  [virtual]
 

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

Reimplemented from vtkCommunicator.

virtual int vtkMPICommunicator::Send (  float *    data,
int    length,
int    remoteProcessId,
int    tag
)  [virtual]
 

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

Reimplemented from vtkCommunicator.

virtual int vtkMPICommunicator::Send (  double *    data,
int    length,
int    remoteProcessId,
int    tag
)  [virtual]
 

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

Reimplemented from vtkCommunicator.

virtual int vtkMPICommunicator::Send (  vtkDataObject *    data,
int    remoteProcessId,
int    tag
)  [inline, virtual]
 

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

Reimplemented from vtkCommunicator.

Definition at line 114 of file vtkMPICommunicator.h.

virtual int vtkMPICommunicator::Send (  vtkDataArray *    data,
int    remoteProcessId,
int    tag
)  [inline, virtual]
 

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

Reimplemented from vtkCommunicator.

Definition at line 116 of file vtkMPICommunicator.h.

int vtkMPICommunicator::NoBlockSend (  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 (  unsigned long *    data,
int    length,
int    remoteProcessId,
int    tag,
Request &    req
) 
 

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

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

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

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

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

virtual int vtkMPICommunicator::Receive (  int *    data,
int    length,
int    remoteProcessId,
int    tag
)  [virtual]
 

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

Reimplemented from vtkCommunicator.

virtual int vtkMPICommunicator::Receive (  unsigned long *    data,
int    length,
int    remoteProcessId,
int    tag
)  [virtual]
 

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

Reimplemented from vtkCommunicator.

virtual int vtkMPICommunicator::Receive (  char *    data,
int    length,
int    remoteProcessId,
int    tag
)  [virtual]
 

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

Reimplemented from vtkCommunicator.

virtual int vtkMPICommunicator::Receive (  unsigned char *    data,
int    length,
int    remoteProcessId,
int    tag
)  [virtual]
 

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

Reimplemented from vtkCommunicator.

virtual int vtkMPICommunicator::Receive (  float *    data,
int    length,
int    remoteProcessId,
int    tag
)  [virtual]
 

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

Reimplemented from vtkCommunicator.

virtual int vtkMPICommunicator::Receive (  double *    data,
int    length,
int    remoteProcessId,
int    tag
)  [virtual]
 

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

Reimplemented from vtkCommunicator.

virtual int vtkMPICommunicator::Receive (  vtkDataObject *    data,
int    remoteProcessId,
int    tag
)  [inline, virtual]
 

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

Reimplemented from vtkCommunicator.

Definition at line 167 of file vtkMPICommunicator.h.

virtual int vtkMPICommunicator::Receive (  vtkDataArray *    data,
int    remoteProcessId,
int    tag
)  [inline, virtual]
 

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

Reimplemented from vtkCommunicator.

Definition at line 169 of file vtkMPICommunicator.h.

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. It blocks until the receive is finished.

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

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

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

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

virtual void vtkMPICommunicator::SetGroup (  vtkMPIGroup *    )  [protected, virtual]
 

virtual void vtkMPICommunicator::SetKeepHandle (  int    )  [protected, virtual]
 

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 (    )  [protected, virtual]
 

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 (    )  [protected, virtual]
 

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::CopyFrom (  vtkMPICommunicator *    source )  [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.

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.

Friends And Related Function Documentation

friend class vtkMPIController [friend]
 

Definition at line 188 of file vtkMPICommunicator.h.

Member Data Documentation

vtkMPICommunicator* vtkMPICommunicator::WorldCommunicator [static, protected]
 

Definition at line 208 of file vtkMPICommunicator.h.

MPI_Comm* vtkMPICommunicator::Handle [protected]
 

Definition at line 226 of file vtkMPICommunicator.h.

vtkMPIGroup* vtkMPICommunicator::Group [protected]
 

Definition at line 227 of file vtkMPICommunicator.h.

int vtkMPICommunicator::Initialized [protected]
 

Definition at line 229 of file vtkMPICommunicator.h.

int vtkMPICommunicator::KeepHandle [protected]
 

Definition at line 230 of file vtkMPICommunicator.h.

The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:36:43 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001