mpi

Class Intercomm

java.lang.Object

mpi.Comm

mpi.Intercomm

public class Intercomm
extends Comm

This class represents intercommunicators.

Field Summary

Fields inherited from class mpi.Comm

handle, MPI_COMM_NULL_VAL

Method Summary

Modifier and Type	Method and Description
Intercomm	clone() Duplicate this communicator.
static Intercomm	getParent() Get the parent of this communicator.
Group	getRemoteGroup() Return the remote group.
int	getRemoteSize() Size of remote group.
Intracomm	merge(boolean high) Create an inter-communicator.

Methods inherited from class mpi.Comm

Abort, bSend, bSendInit, compare, create, createIntercomm, deleteAttr, free, getAttr, getGroup, getRank, getSize, getTopology, ibSend, iProbe, iRecv, irSend, iSend, isInter, isNull, isSend, pack, packSize, probe, recv, recvInit, rSend, rSendInit, send, sendInit, sendRecv, sendRecvReplace, spawn, spawnMultiple, sSend, sSendInit, unpack

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getParent

public static Intercomm getParent()
                           throws MPIException

Get the parent of this communicator.

Returns:

parent of this communicator.

Java binding of the MPI operation MPI_COMM_GET_PARENT.

Throws:

MPIException - Points out that an MPI exception has occured.

getRemoteSize

public int getRemoteSize()
                  throws MPIException

Size of remote group.

Returns:

number of process in remote group of this communicator.

Java binding of the MPI operation MPI_COMM_REMOTE_SIZE.

Throws:

MPIException - Points out that an MPI exception has occured.

getRemoteGroup

public Group getRemoteGroup()
                     throws MPIException

Return the remote group.

Returns:

remote group of this communicator.

Java binding of the MPI operation MPI_COMM_REMOTE_GROUP.

Throws:

MPIException - Points out that an MPI exception has occured.

merge

public Intracomm merge(boolean high)
                throws MPIException

Create an inter-communicator.

Parameters:

high - true if the local group has higher ranks in combined group, otherwise false.

Returns:

new intra-communicator.

Java binding of the MPI operation MPI_INTERCOMM_MERGE.

Throws:

MPIException - Points out that an MPI exception has occured.

clone

public Intercomm clone()
                throws MPIException

Duplicate this communicator.

Overrides:

clone in class Comm

Returns:

copy of this communicator.

Java binding of the MPI operation MPI_COMM_DUP.

The new communicator is ``congruent'' to the old one, but has a different context.

Throws:

MPIException - Points out that an MPI exception has occured.