Open MPI logo

MPI_Cart_rank(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents


C]MPI_Cart_rankR] - Determines process rank in communicator given Cartesian location.


C Syntax

C]#include <mpi.h>int MPI_Cart_rank(MPI_Comm comm, int coords[], int *rank)R]Fortran Syntax

C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_CART_RANK(COMM, COORDS, RANK, IERROR) INTEGER COMM, COORDS(*), RANK, IERRORR]Fortran 2008 Syntax

C]USE mpi_f08MPI_Cart_rank(comm, coords, rank, ierror) TYPE(MPI_Comm), INTENT(IN) :: comm INTEGER, INTENT(IN) :: coords(*) INTEGER, INTENT(OUT) :: rank INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameters

C]commR] : Communicator with Cartesian structure (handle).
C]coordsR] : Integer array (of size ndims, which was defined by C]MPI_Cart_createR] call) specifying the Cartesian coordinates of a process.

Output Parameter

C]rankR] : Rank of specified process (integer).
C]IERRORR] : Fortran only: Error status (integer).


For a process group with Cartesian structure, the function C]MPI_Cart_rankR] translates the logical process coordinates to process C]rankR]s as they are used by the point-to-point routines. For dimension i with periods(i) = true, if the coordinate, C]coords(i)R], is out of range, that is, C]coords(i)R] < 0 or C]coords(i)R] >= C]dims(i)R], it is shifted back to the interval 0 =< C]coords(i)R] < C]dims(i)R] automatically. Out-of-range coordinates are erroneous for nonperiodic dimensions.


Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with C]MPI_Comm_set_errhandlerR]; the predefined error handler C]MPI_ERRORS_RETURNR] may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.

See Also


Table of Contents

« Return to documentation listing