Edit

MPI_Cartdim_get function

  • Article

Retrieves Cartesian topology information associated with a communicator.

Syntax

int MPIAPI MPI_Cartdim_get(
        MPI_Comm comm,
  _Out_ int      *ndims
);

Parameters

  • comm
    Communicator with cartesian structure.

  • ndims [out]
    Number of dimensions of the 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_CARTDIM_GET(COMM, NDIMS, IERROR)
        INTEGER COMM, NDIMS, 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