MPI_Cart_create function - Message Passing Interface (original) (raw)

Makes a new communicator to which topology information has been attached.

Syntax

int MPIAPI MPI_Cart_create(
        MPI_Comm              comm_old,
        int                   ndims,
        _In_count_(ndims) int *dims,
        _In_count_(ndims) int *periods,
        int                   reorder,
  _Out_ MPI_Comm              *comm_cart
);

Parameters

comm_old
Input communicator.
ndims
Number of dimensions of cartesian grid.
dims
Integer array of size ndims specifying the number of processes in each dimension.
periods
Logical array of size ndims specifying whether the grid is periodic (true) or not (false) in each dimension.
reorder
Ranking may be reordered (true) or not (false).
comm_cart [out]
Communicator with new cartesian topology.

Return value

Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.

In Fortran, the return value is stored in the IERROR parameter.

Fortran

    MPI_CART_CREATE(COMM_OLD, NDIMS, DIMS, PERIODS, REORDER, COMM_CART, IERROR)
        INTEGER COMM_OLD, NDIMS, DIMS(*), COMM_CART, IERROR
        LOGICAL PERIODS(*), REORDER

Requirements