Blame www/www3/MPI_Cart_coords.html

Packit Service c5cf8c
Packit Service c5cf8c
<HTML>
Packit Service c5cf8c
<HEAD>
Packit Service c5cf8c
<META NAME="GENERATOR" CONTENT="DOCTEXT">
Packit Service c5cf8c
<TITLE>MPI_Cart_coords</TITLE>
Packit Service c5cf8c
</HEAD>
Packit Service c5cf8c
<BODY BGCOLOR="FFFFFF">
Packit Service c5cf8c

MPI_Cart_coords

Packit Service c5cf8c
Determines process coords in cartesian topology given rank in group 
Packit Service c5cf8c

Synopsis

Packit Service c5cf8c
Packit Service c5cf8c
int MPI_Cart_coords(MPI_Comm comm, int rank, int maxdims, int coords[])
Packit Service c5cf8c
Packit Service c5cf8c

Input Parameters

Packit Service c5cf8c
Packit Service c5cf8c
comm
communicator with cartesian structure (handle)
Packit Service c5cf8c
Packit Service c5cf8c
rank
rank of a process within group of <tt>comm</tt> (integer)
Packit Service c5cf8c
Packit Service c5cf8c
maxdims
length of vector <tt>coords</tt> in the calling program (integer)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Output Parameters

Packit Service c5cf8c
Packit Service c5cf8c
coords
integer array (of size <tt>ndims</tt>) containing the Cartesian
Packit Service c5cf8c
coordinates of specified process (integer)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Thread and Interrupt Safety

Packit Service c5cf8c

Packit Service c5cf8c
This routine is both thread- and interrupt-safe.
Packit Service c5cf8c
This means that this routine may safely be used by multiple threads and
Packit Service c5cf8c
from within a signal handler.
Packit Service c5cf8c

Packit Service c5cf8c

Notes for Fortran

Packit Service c5cf8c
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
Packit Service c5cf8c
an additional argument <tt>ierr</tt> at the end of the argument list.  <tt>ierr
Packit Service c5cf8c
</tt>is an integer and has the same meaning as the return value of the routine
Packit Service c5cf8c
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
Packit Service c5cf8c
<tt>call</tt> statement.
Packit Service c5cf8c

Packit Service c5cf8c
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
Packit Service c5cf8c
</tt>in Fortran.
Packit Service c5cf8c

Packit Service c5cf8c

Errors

Packit Service c5cf8c

Packit Service c5cf8c
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
Packit Service c5cf8c
C routines as the value of the function and Fortran routines in the last
Packit Service c5cf8c
argument.  Before the value is returned, the current MPI error handler is
Packit Service c5cf8c
called.  By default, this error handler aborts the MPI job.  The error handler
Packit Service c5cf8c
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
Packit Service c5cf8c
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
Packit Service c5cf8c
RMA windows).  The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
Packit Service c5cf8c
its use is deprecated.  The predefined error handler
Packit Service c5cf8c
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
Packit Service c5cf8c
Note that MPI does not guarentee that an MPI program can continue past
Packit Service c5cf8c
an error; however, MPI implementations will attempt to continue whenever
Packit Service c5cf8c
possible.
Packit Service c5cf8c

Packit Service c5cf8c
Packit Service c5cf8c
MPI_SUCCESS
No error; MPI routine completed successfully.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_TOPOLOGY
Invalid topology. Either there is no topology
Packit Service c5cf8c
associated with this communicator, or it is not the correct type (e.g.,
Packit Service c5cf8c
<tt>MPI_CART</tt> when expecting <tt>MPI_GRAPH</tt>).
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_RANK
Invalid source or destination rank. Ranks must be between
Packit Service c5cf8c
zero and the size of the communicator minus one; ranks in a receive
Packit Service c5cf8c
(<tt>MPI_Recv</tt>, <tt>MPI_Irecv</tt>, <tt>MPI_Sendrecv</tt>, etc.) may also be <tt>MPI_ANY_SOURCE</tt>.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_DIMS
Invalid dimension argument. A dimension argument
Packit Service c5cf8c
is null or its length is less than or equal to zero.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_ARG
Invalid argument. Some argument is invalid and is not
Packit Service c5cf8c
identified by a specific error class (e.g., <tt>MPI_ERR_RANK</tt>).
Packit Service c5cf8c
Packit Service c5cf8c
</BODY></HTML>