MPI_Cart_coords function

Determines process coords in cartesian topology given rank in group.

Syntax

int MPIAPI MPI_Cart_coords(
   MPI_Comm               comm,
   int                    rank,
   int                    maxdims,
   _Out_cap_(maxdims) int *coords
);

Parameters

  • comm
    Communicator with cartesian structure.

  • rank
    Rank of a process within group of comm.

  • maxdims
    Length of vector coords in the calling program.

  • coords
    Integer array (of size maxdims) containing the Cartesian coordinates of specified process.

Return value

Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.

In Fortran, the return value is stored in the IERROR parameter.

Fortran

    MPI_CART_COORDS(COMM, RANK, MAXDIMS, COORDS, IERROR)
        INTEGER COMM, RANK, MAXDIMS, COORDS(*), IERROR

Requirements

Product

HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities

Header

Mpi.h; Mpif.h

Library

Msmpi.lib

DLL

Msmpi.dll

See also

MPI Process Topology Functions