Open MPI logo

MPI_Cart_coords(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Cart_coordsR] - Determines process coords in Cartesian topology given rank in group.

Syntax

C Syntax



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



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



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

[bu]
C]commR] : Communicator with Cartesian structure (handle).
[bu]
C]rankR] : Rank of a process within group of comm (integer).
[bu]
C]maxdimsR] : Length of vector coords in the calling program (integer). Length of vector coords in the calling program (integer).

Output Parameters

[bu]
C]coordsR] : Integer array (of size ndims,which was defined by MPI_Cart_create call) containing the Cartesian coordinates of specified process (integer).
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

C]MPI_Cart_coordsR] provies a mapping of C]rankR]s to Cartesian coordinates.

Errors

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.


Table of Contents

« Return to documentation listing