9.5.2. Cartesian Convenience Function: MPI_DIMS_CREATE

Up: Topology Constructors Next: Graph Constructor Previous: Cartesian Constructor

For Cartesian topologies, the function MPI_DIMS_CREATE helps the user select a balanced distribution of MPI processes per coordinate direction, depending on the number of MPI processes in the group to be balanced and optional constraints that can be specified by the user.

MPI_DIMS_CREATE(nnodes, ndims, dims)
IN nnodesnumber of nodes in a grid (integer)
IN ndimsnumber of Cartesian dimensions (integer)
INOUT dimsinteger array of size ndims specifying the number of nodes in each dimension
C binding
int MPI_Dims_create(int nnodes, int ndims, int dims[])
Fortran 2008 binding
MPI_Dims_create(nnodes, ndims, dims, ierror)

INTEGER, INTENT(IN) :: nnodes, ndims
INTEGER, INTENT(INOUT) :: dims(ndims)
Fortran binding


The entries in the array dims are set to describe a Cartesian grid with ndims dimensions and a total of nnodes nodes. The dimensions are set to be as close to each other as possible, using an appropriate divisibility algorithm. The caller may further constrain the operation of this routine by specifying elements of array dims. If dims[i] is set to a positive number, the routine will not modify the number of nodes in dimension i; only those entries where dims[i] = 0 are modified by the call.

Negative input values of dims[i] are erroneous. An error will occur if nnodes is not a multiple of

Image file

For dims[i] set by the call, dims[i] will be ordered in nonincreasing order. Array dims is suitable for use as input to routine MPI_CART_CREATE. MPI_DIMS_CREATE is local. If ndims is zero and nnodes is one, MPI_DIMS_CREATE returns MPI_SUCCESS.

Example The use of the array argument dims in MPI_DIMS_CREATE.

dims function call dims
before call on return
(0,0) MPI_DIMS_CREATE(6, 2, dims) (3,2)
(0,0) MPI_DIMS_CREATE(7, 2, dims) (7,1)
(0,3,0) MPI_DIMS_CREATE(6, 3, dims) (2,3,1)
(0,3,0) MPI_DIMS_CREATE(7, 3, dims) erroneous call

Up: Topology Constructors Next: Graph Constructor Previous: Cartesian Constructor

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

(Unofficial) MPI-4.1 of November 2, 2023
HTML Generated on November 19, 2023