MPI_Cart_map function

Maps process to Cartesian topology information.

Syntax

int MPIAPI MPI_Cart_map(
        _In_              MPI_Comm comm,
        _In_range_(>=, 0) int      ndims,
        _In_count_(ndims) int      *dims,
        _In_count_(ndims) int      *periods,
        _Out_             int      *newrank
);

Parameters

• comm
  Input communicator.

• ndims
  Number of dimensions of Cartesian structure.

• dims
  Integer array of size ndims specifying the number of processes in each coordinate direction.

• periods
  Logical array of size ndims specifying the periodicity specification in each coordinate direction.

• newrank [out]
  reordered rank of the calling process; MPI_UNDEFINED if calling process does not belong to grid

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_MAP(COMM, NDIMS, DIMS, PERIODS, NEWRANK, IERROR)
        INTEGER COMM, NDIMS, DIMS(*), NEWRANK, IERROR
        LOGICAL PERIODS(*)

Requirements

See also

MPI Process Topology Functions