Retrieves Cartesian topology information associated with a communicator
int MPI_Cart_get(MPI_Comm comm, int maxdims, int dims, int periods, int coords)
- communicator with cartesian structure (handle)
- length of vectors dims, periods, and coords
in the calling program (integer)
- number of processes for each cartesian dimension (array of integer)
- periodicity (true/false) for each cartesian dimension
(array of logical)
- coordinates of calling process in cartesian structure
(array of integer)
Thread and Interrupt Safety
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
Notes for Fortran
All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK) have
an additional argument ierr at the end of the argument list. ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
All MPI objects (e.g., MPI_Datatype, MPI_Comm) are of type INTEGER
All MPI routines (except MPI_Wtime and MPI_Wtick) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with MPI_Comm_set_errhandler (for communicators),
MPI_File_set_errhandler (for files), and MPI_Win_set_errhandler (for
RMA windows). The MPI-1 routine MPI_Errhandler_set may be used but
its use is deprecated. The predefined error handler
MPI_ERRORS_RETURN may be used to cause error values to be returned.
Note that MPI does not guarentee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
- No error; MPI routine completed successfully.
- Invalid topology. Either there is no topology
associated with this communicator, or it is not the correct type (e.g.,
MPI_CART when expecting MPI_GRAPH).
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in MPI_Comm_rank).
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g., MPI_ERR_RANK).