MPI_Cart_get function

Retrieves Cartesian topology information associated with a communicator.

Syntax

int MPIAPI MPI_Cart_get(
   MPI_Comm               comm,
   int                    maxdims,
   _Out_cap_(maxdims) int *dims,
   _Out_cap_(maxdims) int *periods,
   _Out_cap_(maxdims) int *coords
);

Parameters

• comm
  Communicator with cartesian structure.

• maxdims
  Length of vectors dims, periods, and coords in the calling program.

• dims
  Number of processes for each cartesian dimension.

• periods
  Periodicity (true/false) for each cartesian dimension.

• coords
  Coordinates of calling process in cartesian structure.

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_GET(COMM, MAXDIMS, DIMS, PERIODS, COORDS, IERROR)
        INTEGER COMM, MAXDIMS, DIMS(*), COORDS(*), IERROR
        LOGICAL PERIODS(*)

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