Edit

Share via


MPI_Cart_rank function

Determines process rank in communicator given Cartesian location.

Syntax

int MPIAPI MPI_Cart_rank(
        MPI_Comm comm,
  _In_  int      *coords,
  _Out_ int      *rank
);

Parameters

  • comm
    Communicator with cartesian structure.

  • coords [in]
    Integer array (of size ndims, the number of dimensions of the Cartesian topology associated with comm) specifying the cartesian coordinates of a process.

  • rank [out]
    Rank 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_RANK(COMM, COORDS, RANK, IERROR)
        INTEGER COMM, COORDS(*), RANK, 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