vtkMPICommunicator Class Reference

#include <vtkMPICommunicator.h>

Inheritance diagram for vtkMPICommunicator:

[legend]

Collaboration diagram for vtkMPICommunicator:

[legend]

List of all members.

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.


Public Types
typedef vtkCommunicator	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 ()
void	CopyFrom (vtkMPICommunicator *source)

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 ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMPICommunicator *	SafeDownCast (vtkObject *o)
static vtkMPICommunicator *	New ()
static vtkMPICommunicator *	GetWorldCommunicator ()
static char *	Allocate (size_t size)
static void	Free (char *ptr)
Protected Member Functions
	vtkMPICommunicator ()
	~vtkMPICommunicator ()
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)
Static Protected Member Functions
static int	CheckForMPIError (int err)
Protected Attributes
vtkMPICommunicatorOpaqueComm *	MPIComm
int	Initialized
int	KeepHandle
int	LastSenderId
int	UseSsend
Static Protected Attributes
static vtkMPICommunicator *	WorldCommunicator
Friends
class	vtkMPIController
Classes
class	Request

Member Typedef Documentation

typedef vtkCommunicator vtkMPICommunicator::Superclass

Reimplemented from vtkCommunicator.

Definition at line 70 of file vtkMPICommunicator.h.

Constructor & Destructor Documentation

vtkMPICommunicator::vtkMPICommunicator ( ) [protected]

vtkMPICommunicator::~vtkMPICommunicator ( ) [protected]

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
	)