MPI_Cart_coords(3)

NAME
MPI_Cart_coords - Returns the coordinates corresponding to a given rank in the cartesian communicator

SYNOPSIS
#include <mpi.h>
int MPI_Cart_coords(MPI_Comm comm, int rank, int maxdims, int *coords);

#include <pmpi.h>
int PMPI_Cart_coords(MPI_Comm comm, int rank, int maxdims, int *coords);

#include <mpi.h>
void MPI::Cartcomm::Get_coords(int rank, int maxdims, int *coords) const;

INCLUDE 'mpif.h'
MPI_CART_COORDS(comm, rank, maxdims, coords, ierr)
INTEGER comm, rank, maxdims, coords(*), ierr

INPUT PARAMETERS
comm
    - cartesian communicator (handle)
rank
    - rank to obtain coordinates for (integer)
maxdims
    - size of the coords array (integer)

OUTPUT PARAMETER
coords
    - the coordinates of the requested rank (array).

DESCRIPTION
The MPI_Cart_coords() function is used to obtain the coordinates, coords corresponding to a given rank within a cartesian communicator comm. The coordinates array is of size maxdims. If this is not the same size as the number of coordinates, then a MPI_ERR_DIMS error will be returned. Otherwise, the coordinate array is filled with the details for the requested rank. The communicator must be a valid one (not MPI_COMM_NULL). PMPI_Cart_coords() is the profiling version of this function.

ERRORS
All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable. In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.
MPI_SUCCESS
    - No error;
MPI_ERR_PENDING
    - Pending exception;
MPI_ERR_COMM
    - Invalid communicator;
MPI_ERR_TOPOLOGY
    - Not a cartesian communicator;
MPI_ERR_DIMS
    - Wrong size of coordinate array;
MPI_ERR_RANK
    - Invalid rank;
MPI_ERR_ARG
    - Invalid output pointer.

SEE ALSO
MPI_Cart_create(3), MPI_Cartdim_get(3), MPI_Dims_create(3), MPI_Cart_get(3), MPI_Cart_rank(3), MPI_Cart_map(3),