MPI_CART_GET(3)MPI_CART_GET(3)NAMEMPI_Cart_get - Retrieves Cartesian topology information associated with a
communicator
SYNOPSIS
C:
#include <mpi.h>
int MPI_Cart_get ( comm, maxdims, dims, periods, coords )
MPI_Comm comm;
int maxdims;
int *dims, *periods, *coords;
C++:
#include <mpi.h>
void Cartcomm::Get_topo(
int maxdims,
int dims[],
bool periods[],
int coords[]) const
Fortran:
INCLUDE "mpif.h" (or USE MPI)
INTEGER comm, maxdims, dims(*), coords(*),
ierror
LOGICAL periods(*)
CALL MPI_CART_GET(comm, maxdims, dims(*),
periods(*), coords(*), ierror)
STANDARDS
This release implements the MPI 1.2 standard, as documented by the MPI
Forum in the spring 1997 release of MPI: A Message Passing Interface
Standard.
DESCRIPTION
The MPI_Cart_get routine retrieves Cartesian topology information
associated with a communicator. This routine accepts the following
parameters:
comm Specifies a communicator with Cartesian structure (handle)
Page 1
MPI_CART_GET(3)MPI_CART_GET(3)
maxdims Specifies the length of vector dimensions, periods, and
coordinates in the calling program (integer)
dims Returns the number of processes for each Cartesian
dimension (array of integer)
periods Returns periodicity (true/false) for each Cartesian
dimension (array of logical)
coords Returns the coordinates of the calling process in
Cartesian structure (array of integer)
ierror Specifies the return code value for successful completion,
which is in MPI_SUCCESS. MPI_SUCCESS is defined in the
mpif.h file.
Page 2
