Open MPI logo

MPI_Cart_get(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Cart_getR] - Retrieves Cartesian topology information associated with a communicator.

Syntax

C Syntax



C]#include <mpi.h>int MPI_Cart_get(MPI_Comm comm, int maxdims, int dims[], int periods[], int coords[])R]Fortran Syntax



C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_CART_GET(COMM, MAXDIMS, DIMS, PERIODS, COORDS, IERROR) INTEGER COMM, MAXDIMS, DIMS(*), COORDS(*), IERROR LOGICAL PERIODS(*)R]Fortran 2008 Syntax



C]USE mpi_f08MPI_Cart_get(comm, maxdims, dims, periods, coords, ierror) TYPE(MPI_Comm), INTENT(IN) :: comm INTEGER, INTENT(IN) :: maxdims INTEGER, INTENT(OUT) :: dims(maxdims), coords(maxdims) LOGICAL, INTENT(OUT) :: periods(maxdims) INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameters

[bu]
C]commR] : Communicator with Cartesian structure (handle).
[bu]
C]maxdimsR] : Length of vectors dims, periods, and coords in the calling program (integer).

Output Parameters

[bu]
C]dimsR] : Number of processes for each Cartesian dimension (array of integers).
[bu]
C]periodsR] : Periodicity (true/false) for each Cartesian dimension (array of logicals).
[bu]
C]coordsR] : Coordinates of calling process in Cartesian structure (array of integers).
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

The functions C]MPI_Cartdim_getR] and C]MPI_Cart_getR] return the Cartesian topology information that was associated with a C]commR]unicator by C]MPI_Cart_create.R]

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 C]MPI_Comm_set_errhandlerR]; the predefined error handler C]MPI_ERRORS_RETURNR] 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

C]MPI_Cartdim_getR](3) C]MPI_Cart_createR](3)


Table of Contents

« Return to documentation listing