mpi
Class MPI

java.lang.Object
  extended by mpi.MPI

public class MPI
extends java.lang.Object


Field Summary
static int ANY_SIZE
           
static int ANY_SOURCE
           
static int ANY_TAG
           
static int ANY_TYPE
           
static Op BAND
           
static Datatype BOOLEAN
           
static Op BOR
           
static int BSEND_OVERHEAD
           
static Op BXOR
           
static Datatype BYTE
           
static int CART
           
static Datatype CHAR
           
static Comm COMM_NULL
           
static Comm COMM_SELF
           
static Intracomm COMM_WORLD
           
static int CONGRUENT
           
static Datatype DOUBLE
           
static Datatype DOUBLE2
           
static Status EMPTY_STATUS
           
static Errhandler ERRORS_ARE_FATAL
           
static Errhandler ERRORS_RETURN
           
static Datatype FLOAT
           
static Datatype FLOAT2
           
static int GRAPH
           
static Group GROUP_EMPTY
           
static Group GROUP_NULL
           
static Keyval HOST
           
static int IDENT
           
static Datatype INT
           
static Datatype INT2
           
static Keyval IO
           
static Op LAND
           
static Datatype LB
           
static Datatype LONG
           
static Datatype LONG2
           
static Op LOR
           
static Op LXOR
           
static Op MAX
           
static Op MAXLOC
           
static Op MIN
           
static Op MINLOC
           
static int NUM_OF_PROCESSORS
           
static Datatype OBJECT
           
static Datatype PACKED
           
static int PROC_NULL
           
static Op PROD
           
static Request REQUEST_NULL
           
static Datatype SHORT
           
static Datatype SHORT2
           
static int SIMILAR
           
static Op SUM
           
static Keyval TAG_UB
           
static int THREAD_FUNNELED
           
static int THREAD_MULTIPLE
           
static int THREAD_SERIALIZED
           
static int THREAD_SINGLE
           
static Datatype UB
           
static int UNDEFINED
           
static int UNEQUAL
           
static Keyval UNIVERSE_SIZE
           
static Keyval WTIME_IS_GLOBAL
           
 
Method Summary
static void Buffer_attach(BufferMPI buffer)
          Attaches a user-provided buffer for sending.
static void Buffer_detach()
          Detach the buffer currently associated with MPI.
static Keyval Comm_create_keyval()
          Create a new attribute key.
static void Comm_free_keyval(Keyval key)
          Frees an attribute key for communicators.
static void Finalize()
          Terminates MPI execution environment.
static boolean Finalized()
          Indicates whether MPI.Finalize has been called.
static java.lang.String Get_processor_name()
          Returns the name of the processor on which it is called.
static int[] Get_version()
          Return the version number of MPI.
static int Init_thread(java.lang.String[] argv, int required)
          Initialize the MPI execution environment.
static java.lang.String[] Init(java.lang.String[] argv)
          Initialize the MPI execution environment.
static boolean Initialized()
          Indicates whether MPI.Init has been called.
static boolean Is_thread_main()
          Returns a boolean indicating whether this thread called MPI.INIT or MPI.INIT_THREAD.
static int queryThread()
          Returns the level of thread support provided by the MPI library and the underlying device selected.
static double Wtick()
          Returns the resolution of MPI.Wtime.
static double Wtime()
          Returns wallclock time.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BSEND_OVERHEAD

public static int BSEND_OVERHEAD

BYTE

public static final Datatype BYTE

CHAR

public static final Datatype CHAR

SHORT

public static final Datatype SHORT

BOOLEAN

public static final Datatype BOOLEAN

INT

public static final Datatype INT

LONG

public static final Datatype LONG

FLOAT

public static final Datatype FLOAT

DOUBLE

public static final Datatype DOUBLE

OBJECT

public static final Datatype OBJECT

PACKED

public static final Datatype PACKED

UB

public static final Datatype UB

LB

public static final Datatype LB

SHORT2

public static final Datatype SHORT2

INT2

public static final Datatype INT2

LONG2

public static final Datatype LONG2

FLOAT2

public static final Datatype FLOAT2

DOUBLE2

public static final Datatype DOUBLE2

MAX

public static final Op MAX

MIN

public static final Op MIN

SUM

public static final Op SUM

PROD

public static final Op PROD

LAND

public static final Op LAND

BAND

public static final Op BAND

LOR

public static final Op LOR

BOR

public static final Op BOR

LXOR

public static final Op LXOR

BXOR

public static final Op BXOR

MINLOC

public static final Op MINLOC

MAXLOC

public static final Op MAXLOC

IDENT

public static final int IDENT
See Also:
Constant Field Values

SIMILAR

public static final int SIMILAR
See Also:
Constant Field Values

UNEQUAL

public static final int UNEQUAL
See Also:
Constant Field Values

CONGRUENT

public static final int CONGRUENT
See Also:
Constant Field Values

TAG_UB

public static final Keyval TAG_UB

HOST

public static final Keyval HOST

IO

public static final Keyval IO

WTIME_IS_GLOBAL

public static final Keyval WTIME_IS_GLOBAL

UNIVERSE_SIZE

public static final Keyval UNIVERSE_SIZE

THREAD_SINGLE

public static final int THREAD_SINGLE
See Also:
Constant Field Values

THREAD_FUNNELED

public static final int THREAD_FUNNELED
See Also:
Constant Field Values

THREAD_SERIALIZED

public static final int THREAD_SERIALIZED
See Also:
Constant Field Values

THREAD_MULTIPLE

public static final int THREAD_MULTIPLE
See Also:
Constant Field Values

GRAPH

public static final int GRAPH
See Also:
Constant Field Values

CART

public static final int CART
See Also:
Constant Field Values

UNDEFINED

public static final int UNDEFINED
See Also:
Constant Field Values

ANY_SOURCE

public static final int ANY_SOURCE
See Also:
Constant Field Values

ANY_TAG

public static final int ANY_TAG
See Also:
Constant Field Values

ANY_TYPE

public static final int ANY_TYPE
See Also:
Constant Field Values

ANY_SIZE

public static final int ANY_SIZE
See Also:
Constant Field Values

PROC_NULL

public static final int PROC_NULL
See Also:
Constant Field Values

EMPTY_STATUS

public static final Status EMPTY_STATUS

REQUEST_NULL

public static final Request REQUEST_NULL

COMM_WORLD

public static Intracomm COMM_WORLD

COMM_SELF

public static Comm COMM_SELF

COMM_NULL

public static Comm COMM_NULL

GROUP_NULL

public static final Group GROUP_NULL

GROUP_EMPTY

public static final Group GROUP_EMPTY

ERRORS_ARE_FATAL

public static Errhandler ERRORS_ARE_FATAL

ERRORS_RETURN

public static Errhandler ERRORS_RETURN

NUM_OF_PROCESSORS

public static final int NUM_OF_PROCESSORS
Method Detail

Get_version

public static int[] Get_version()
                         throws MPIException
Return the version number of MPI. returns: int[0] Version of MPI int[1] Subversion of MPI

Java binding of the MPI operation MPI_GET_VERSION.

The "version" will be represented by two separate integers in the returned array, for the version (int[0]) and subversion (int[1]).

Throws:
MPIException

Init

public static java.lang.String[] Init(java.lang.String[] argv)
                               throws MPIException
Initialize the MPI execution environment.

argv arguments to main method.

Java binding of the MPI operation MPI_INIT.

Throws:
MPIException

Init_thread

public static int Init_thread(java.lang.String[] argv,
                              int required)
                       throws MPIException
Initialize the MPI execution environment.

args arguments to main method.
required Level of desired thread support
returns: Level of provided thread support

Java binding of the MPI operation MPI_INIT_THREAD.

Throws:
MPIException

Is_thread_main

public static boolean Is_thread_main()
Returns a boolean indicating whether this thread called MPI.INIT or MPI.INIT_THREAD.

Java binding of the MPI operation MPI_IS_THREAD_MAIN.

This method can be called by a thread to find out whether it is the main thread (the thread that called MPI.INIT or MPI.INIT_THREAD).


queryThread

public static int queryThread()
Returns the level of thread support provided by the MPI library and the underlying device selected.

returns: Level of thread support provided by the MPI library (integer)

Java binding of the MPI operation MPI_QUERY_THREAD.


Finalize

public static void Finalize()
                     throws MPIException
Terminates MPI execution environment.

Java binding of the MPI operation MPI_FINALIZE.

Throws:
MPIException

Buffer_attach

public static void Buffer_attach(BufferMPI buffer)
                          throws MPIException
Attaches a user-provided buffer for sending.

buffer BufferMPI object

Java binding of the MPI operation MPI_BUFFER_ATTACH.

Provides to MPI a buffer in user's memory to be used for buffering outgoing messages. The buffer is used only by messages sent in buffered mode. Only one buffer can be attached to a process at a time.

Throws:
MPIException

Buffer_detach

public static void Buffer_detach()
                          throws MPIException
Detach the buffer currently associated with MPI.

Java binding of the MPI operation MPI_BUFFER_DETACH.

Throws:
MPIException

Get_processor_name

public static java.lang.String Get_processor_name()
                                           throws MPIException
Returns the name of the processor on which it is called.

returns: A unique specifier for the actual node.

Java binding of the MPI operation MPI_GET_PROCESSOR_NAME.

Throws:
MPIException

Wtime

public static double Wtime()
Returns wallclock time.

returns: elapsed wallclock time in seconds since some time in the past

Java binding of the MPI operation MPI_WTIME.

If the attribute MPI.WTIME_IS_GLOBAL is defined and true, then the value is synchronized across all processes in MPI.COMM_WORLD.


Wtick

public static double Wtick()
Returns the resolution of MPI.Wtime.

returns: resolution of MPI.Wtime in seconds.

Java binding of the MPI operation MPI_WTICK.


Initialized

public static boolean Initialized()
Indicates whether MPI.Init has been called.

returns: true if Init has been called, false otherwise.

Java binding of the MPI operation MPI_INITIALIZED.

This routine may be used to determine whether MPI.INIT has been called. It is the only MPI-1 routine that may be called before MPI.INIT is called.


Finalized

public static boolean Finalized()
Indicates whether MPI.Finalize has been called.

returns: true if Finalize has been called, false otherwise.

Java binding of the MPI operation MPI_FINALIZED.

This routine returns true if MPI.FINALIZE has completed. It is legal to call MPI.FINALIZED before MPI.INIT and after MPI.FINALIZE.


Comm_create_keyval

public static Keyval Comm_create_keyval()
Create a new attribute key.

returns: key value for future access

Java binding of the MPI operation MPI_COMM_CREATE_KEYVAL.


Comm_free_keyval

public static void Comm_free_keyval(Keyval key)
Frees an attribute key for communicators.

key key value

Java binding of the MPI operation MPI_COMM_FREE_KEYVAL.