Open MPI logo

MPI_Cart_create(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Cart_createR] - Makes a new communicator to which Cartesian topology information has been attached.

Syntax

C Syntax



C]#include <mpi.h>int MPI_Cart_create(MPI_Comm comm_old, int ndims, const int dims[], const int periods[], int reorder, MPI_Comm *comm_cart)R]Fortran Syntax



C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_CART_CREATE(COMM_OLD, NDIMS, DIMS, PERIODS, REORDER, COMM_CART, IERROR) INTEGER COMM_OLD, NDIMS, DIMS(*), COMM_CART, IERROR LOGICAL PERIODS(*), REORDERR]Fortran 2008 Syntax



C]USE mpi_f08MPI_Cart_create(comm_old, ndims, dims, periods, reorder, comm_cart, ierror) TYPE(MPI_Comm), INTENT(IN) :: comm_old INTEGER, INTENT(IN) :: ndims, dims(ndims) LOGICAL, INTENT(IN) :: periods(ndims), reorder TYPE(MPI_Comm), INTENT(OUT) :: comm_cart INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameters

[bu]
C]comm_oldR] : Input communicator (handle).
[bu]
C]ndimsR] : Number of dimensions of Cartesian grid (integer).
[bu]
C]dimsR] : Integer array of size ndims specifying the number of processes in each dimension.
[bu]
C]periodsR] : Logical array of size ndims specifying whether the grid is periodic (true) or not (false) in each dimension.
[bu]
C]reorderR] : Ranking may be reordered (true) or not (false) (logical).

Output Parameters

[bu]
C]comm_cartR] : Communicator with new Cartesian topology (handle).
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

C]MPI_Cart_createR] returns a handle to a new communicator to which the Cartesian topology information is attached. If C]reorderR] = false then the rank of each process in the new group is identical to its rank in the old group. Otherwise, the function may C]reorderR] the processes (possibly so as to choose a good embedding of the virtual topology onto the physical machine). If the total size of the Cartesian grid is smaller than the size of the group of comm, then some processes are returned C]MPI_COMM_NULLR], in analogy to C]MPI_Comm_splitR]. The call is erroneous if it specifies a grid that is larger than the group size.

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.


Table of Contents

« Return to documentation listing