NAME

MPI_Cart_create - Creates a cartesian communicator

SYNOPSIS

#include <mpi.h> 
int MPI_Cart_create(MPI_Comm comm , int ndims , int *dims , int *periods , int reorder ,
	 MPI_Comm *out ); 
#include <pmpi.h> 
int PMPI_Cart_create(MPI_Comm comm , int ndims , int *dims , int *periods , int reorder ,
	 MPI_Comm *out ); 

INPUT PARAMETERS

comm - communicator (handle)

ndims - number of dimensions (integer)

dims - array of dimensions (array)

periods - is a dimension periodic (array)

reorder - reorder ranks for optimal placement (boolean)

OUTPUT PARAMETER

out - the new cartesian communicator (handle).

DESCRIPTION

The MPI_Cart_create() function is used to create a new cartesian communicator out with ndims dimensions specified in the dims array. Periodicity information is stored in the periods array, which affects the output of the MPI_Cart_map() function.

If reorder is true, then the output ranks will be arranged in an optimal order. Otherwise, the same order as in comm is chosen.

If the size of the new communicator is smaller than current communicator, then some of the nodes will receive an output of MPI_COMM_NULL. The new communicator should eventually be freed with MPI_Comm_free.

Note that the input communicator must be valid (not MPI_COMM_NULL). PMPI_Cart_create() is the profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

MPI_SUCCESS - No error;

MPI_ERR_COMM - Invalid communicator;

MPI_ERR_DIMS - Invalid dimensions;

MPI_ERR_ARG - Invalid output pointer;

MPI_ERR_INTERN - Out of Memory. This may be fatal.

SEE ALSO

MPI_Dims_create (3) MPI_Cartdim_get (3) MPI_Cart_get (3) MPI_Cart_map (3) MPI_Graph_create (3) MPI_Graphdims_get (3) MPI_Comm_free (3)

• Lockless
• MPI Documentation
• MPI_Cart_create