17.2.41. MPI_Cartdim_get

MPI_Cartdim_get - Retrieves Cartesian topology information associated with a communicator.

17.2.41.1. Syntax

17.2.41.1.1. C Syntax

#include <mpi.h>

int MPI_Cartdim_get(MPI_Comm comm, int *ndims)

17.2.41.1.2. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'

MPI_CARTDIM_GET(COMM, NDIMS, IERROR)
    INTEGER COMM, NDIMS, IERROR

17.2.41.1.3. Fortran 2008 Syntax

USE mpi_f08

MPI_Cartdim_get(comm, ndims, ierror)
    TYPE(MPI_Comm), INTENT(IN) :: comm
    INTEGER, INTENT(OUT) :: ndims
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.41.2. Input Parameter

  • comm : Communicator with Cartesian structure (handle).

17.2.41.3. Output Parameters

  • ndims : Number of dimensions of the Cartesian structure (integer).

  • IERROR : Fortran only: Error status (integer).

17.2.41.4. Description

MPI_Cartdim_get returns the number of dimensions of the Cartesian structure.

17.2.41.5. Errors

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.

See also

MPI_Cart_get