Synopsis
int MPI_Cart_create(MPI_Comm comm_old, int ndims, const int dims[],
const int periods[], int reorder, MPI_Comm *comm_cart)
Input Parameters
- comm_old
-
input communicator (handle)
- ndims
-
number of dimensions of Cartesian grid (integer)
- dims
-
integer array of size ndims specifying the number of processes in each dimension (integer)
- periods
-
logical array of size ndims specifying whether the grid is periodic (true) or not (false) in each dimension (logical)
- reorder
-
ranking may be reordered (true) or not (false)
Output Parameters
- comm_cart
-
communicator with new Cartesian topology (handle)
Description
MPI_Cart_create creates a new communicator with Cartesian topology information attached.
This collective operation returns a handle to a new communicator to which the Cartesian topology information is attached. If reorder = false, the rank of each process in the new communicator is identical to its rank in comm_old; if reorder = true, the function may reorder the ranks to achieve a better mapping 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_old, some processes return MPI_COMM_NULL. If ndims is zero, a zero-dimensional Cartesian topology is created. All input arguments must have identical values on all processes of comm_old. The call is erroneous if the specified grid is larger than the group size or if ndims is negative. As with other collective calls, programs must be written to work correctly whether the call synchronizes or not.
Algorithm
We ignore reorder info currently.
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 'call' statement.
All MPI objects (e.g., 'MPI_Datatype', 'MPI_Comm') are of type 'INTEGER' in Fortran.
Errors
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 guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
-
MPI_SUCCESS - No error; MPI routine completed successfully.
-
MPI_ERR_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., 'MPI_ERR_RANK').
-
MPI_ERR_COMM - Invalid communicator. A common error is to use a null communicator in a call (not even allowed in 'MPI_Comm_rank').
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.