mpi

Class Graphcomm

java.lang.Object

mpi.Comm

mpi.Intracomm

mpi.Graphcomm

public class Graphcomm
extends Intracomm

The class represents a communicator with a graph structure.

Field Summary

Fields inherited from class mpi.Comm

handle, MPI_COMM_NULL_VAL

Method Summary

Modifier and Type	Method and Description
Graphcomm	clone() Duplicate this communicator.
GraphParms	getDims() Returns graph topology information.
int[]	getNeighbours(int rank) Provides adjacency information for general graph topology.
int	getTopology() Returns the type of topology associated with the communicator.
int	map(int[] index, int[] edges) Compute an optimal placement.

Methods inherited from class mpi.Intracomm

allGather, allGatherv, allReduce, allToAll, allToAllv, barrier, bcast, create, createCart, createGraph, createGroup, gather, gatherv, nativeGatherv, reduce, reduceScatter, scan, scatter, scatterv, split

Methods inherited from class mpi.Comm

Abort, bSend, bSendInit, compare, create, createIntercomm, deleteAttr, free, getAttr, getGroup, getRank, getSize, 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

clone

public Graphcomm clone()
                throws MPIException

Description copied from class: Intracomm

Duplicate this communicator.

Overrides:

clone in class Intracomm

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.

getDims

public GraphParms getDims()
                   throws MPIException

Returns graph topology information.

Returns:

object defining node degrees and edges of graph.

Java binding of the MPI operation MPI_GRAPHDIMS_GET.

The number of nodes and number of edges can be extracted from the sizes of the index and edges fields of the returned object.

Throws:

MPIException - Points out that an MPI exception has occured.

getNeighbours

public int[] getNeighbours(int rank)
                    throws MPIException

Provides adjacency information for general graph topology.

Parameters:

rank - rank of a process in the group of this communicator.

Returns:

array of ranks of neighbouring processes to one specified.

Java binding of the MPI operations MPI_GRAPH_NEIGHBOURS_COUNT and MPI_GRAPH_NEIGHBOURS.

The number of neighbours can be extracted from the size of the result.

Throws:

MPIException - Points out that an MPI exception has occured.

map

public int map(int[] index,
               int[] edges)
        throws MPIException

Compute an optimal placement.

Parameters:

index - node degrees.

edges - graph edges.

Returns:

reordered rank of calling process.

Java binding of the MPI operation MPI_GRAPH_MAP.

The number of nodes is taken to be size of the index argument.

Throws:

MPIException - Points out that an MPI exception has occured.

getTopology

public int getTopology()
                throws MPIException

Returns the type of topology associated with the communicator.

Not Implemented in the current release

.

Overrides:

getTopology in class Comm

Returns:

topology type of communicator.

Java binding of the MPI operation MPI_TOPO_TEST.

The return value will be one of MPI.GRAPH, MPI.CART or MPI.UNDEFINED.

Throws:

MPIException - Points out that an MPI exception has occured.