180. Cartesian Constructor

PreviousUpNext
Up: Topology Constructors Next: Cartesian Convenience Function: MPI_DIMS_CREATE Previous: Topology Constructors

MPI_CART_CREATE(comm_old, ndims, dims, periods, reorder, comm_cart)
IN comm_old input communicator (handle)
IN ndims number of dimensions of Cartesian grid (integer)
IN dims integer array of size ndims specifying the number of processes in each dimension
IN periods logical array of size ndims specifying whether the grid is periodic ( true) or not ( false) in each dimension
IN reorder ranking may be reordered ( true) or not ( false) (logical)
OUT comm_cart communicator with new Cartesian topology (handle)

int MPI_Cart_create(MPI_Comm comm_old, int ndims, const int dims[], const int periods[], int reorder, MPI_Comm *comm_cart)

MPI_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) :: ierror
MPI_CART_CREATE(COMM_OLD, NDIMS, DIMS, PERIODS, REORDER, COMM_CART, IERROR)
INTEGER COMM_OLD, NDIMS, DIMS(*), COMM_CART, IERROR
LOGICAL PERIODS(*), REORDER

MPI_CART_CREATE returns a handle to a new communicator to which the Cartesian topology information is attached. If reorder = false then the rank of each process in the new group is identical to its rank in the old group. Otherwise, the function may reorder 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_old, then some processes are returned MPI_COMM_NULL, in analogy to MPI_COMM_SPLIT. If ndims is zero then a zero-dimensional Cartesian topology is created. The call is erroneous if it specifies a grid that is larger than the group size or if ndims is negative.


PreviousUpNext
Up: Topology Constructors Next: Cartesian Convenience Function: MPI_DIMS_CREATE Previous: Topology Constructors


Return to MPI-3.1 Standard Index
Return to MPI Forum Home Page

(Unofficial) MPI-3.1 of June 4, 2015
HTML Generated on June 4, 2015