The distributed array type constructor supports HPF-like [49] data distributions. However, unlike in HPF, the storage order may be specified for C arrays as well as for Fortran arrays.

* Advice to users.*

One can create an HPF-like file view using this type constructor
as follows.
Complementary filetypes are created by having every process of a group
call this constructor with identical arguments
(with the exception of rank which should be set appropriately).
These filetypes (along with identical disp and etype)
are then used to define the view (via MPI_FILE_SET_VIEW),
see MPI I/O, especially Section Definitions
and Section File Views.
Using this view,
a collective data access operation (with identical offsets)
will yield an HPF-like distribution pattern.
(* End of advice to users.*)

MPI_TYPE_CREATE_DARRAY(size, rank, ndims, array_of_gsizes, array_of_distribs, array_of_dargs, array_of_psizes, order, oldtype, newtype) | |

IN size | size of process group (positive integer) |

IN rank | rank in process group (non-negative integer) |

IN ndims | number of array dimensions as well as process grid dimensions (positive integer) |

IN array_of_gsizes | number of elements of type oldtype in each dimension of global array (array of positive integers) |

IN array_of_distribs | distribution of array in each dimension (array of states) |

IN array_of_dargs | distribution argument in each dimension (array of positive integers) |

IN array_of_psizes | size of process grid in each dimension (array of positive integers) |

IN order | array storage order flag (state) |

IN oldtype | old datatype (handle) |

OUT newtype | new datatype (handle) |

INTEGER, INTENT(IN) :: size, rank, ndims, array_of_gsizes(ndims), array_of_distribs(ndims), array_of_dargs(ndims), array_of_psizes(ndims), order

TYPE(MPI_Datatype), INTENT(IN) :: oldtype

TYPE(MPI_Datatype), INTENT(OUT) :: newtype

INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INTEGER, INTENT(IN) :: size, rank, ndims, array_of_distribs(ndims), array_of_dargs(ndims), array_of_psizes(ndims), order

INTEGER(KIND=MPI_COUNT_KIND), INTENT(IN) :: array_of_gsizes(ndims)

TYPE(MPI_Datatype), INTENT(IN) :: oldtype

TYPE(MPI_Datatype), INTENT(OUT) :: newtype

INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INTEGER SIZE, RANK, NDIMS, ARRAY_OF_GSIZES(*), ARRAY_OF_DISTRIBS(*), ARRAY_OF_DARGS(*), ARRAY_OF_PSIZES(*), ORDER, OLDTYPE, NEWTYPE, IERROR

MPI_TYPE_CREATE_DARRAY can be used to generate
the datatypes corresponding to the distribution
of an ndims-dimensional array of oldtype elements
onto
an ndims-dimensional grid of logical processes.
Unused dimensions of array_of_psizes should be set to 1
(see Example Distributed Array Datatype Constructor).
For a call to MPI_TYPE_CREATE_DARRAY to be correct,
the equation *prod _{i=0}^{ndims-1} array_of_psizes[i] = size *
must be satisfied.
The ordering of processes in the process grid is assumed to be
row-major, as in the case of virtual Cartesian process topologies.

For both Fortran and C arrays, the ordering of processes in the
process grid is assumed to be row-major. This is consistent with the
ordering used in virtual Cartesian process topologies in
MPI.
To create such virtual process topologies, or to find the coordinates
of a process in the process grid, etc., users may use the corresponding
process topology procedures,
see Chapter Virtual Topologies for MPI Processes.
(* End of advice to users.*)

Each dimension of the array
can be
distributed in one of three ways:

The constant MPI_DISTRIBUTE_DFLT_DARG specifies
a default distribution argument.
The distribution argument for a dimension that is not distributed
is ignored.
For any dimension
i
in which the distribution
is MPI_DISTRIBUTE_BLOCK,
it is erroneous
to specify
array_of_dargs[i] *** array_of_psizes[i]
*<* array_of_gsizes[i].

For example, the HPF layout `ARRAY(CYCLIC(15))`
corresponds to MPI_DISTRIBUTE_CYCLIC
with a distribution argument of 15, and the HPF layout `ARRAY(BLOCK)`
corresponds to
MPI_DISTRIBUTE_BLOCK with a distribution argument of
MPI_DISTRIBUTE_DFLT_DARG.

The order argument is used as in MPI_TYPE_CREATE_SUBARRAY to specify the storage order. Therefore, arrays described by this type constructor may be stored in Fortran (column-major) or C (row-major) order. Valid values for order are MPI_ORDER_FORTRAN and MPI_ORDER_C.

This routine creates a new MPI datatype with a typemap defined in terms of a function called ``cyclic()'' (see below).

Without loss of generality, it suffices to define the typemap for the MPI_DISTRIBUTE_CYCLIC case where MPI_DISTRIBUTE_DFLT_DARG is not used.

MPI_DISTRIBUTE_BLOCK and MPI_DISTRIBUTE_NONE can be reduced to the MPI_DISTRIBUTE_CYCLIC case for dimension i as follows.

MPI_DISTRIBUTE_BLOCK with array_of_dargs[i] equal to MPI_DISTRIBUTE_DFLT_DARG is equivalent to MPI_DISTRIBUTE_CYCLIC with array_of_dargs[i] set to

*
(mpiargarray_of_gsizes[i] + mpiargarray_of_psizes[i] - 1)
/ mpiargarray_of_psizes[i].
*

If array_of_dargs[i] is not MPI_DISTRIBUTE_DFLT_DARG, then MPI_DISTRIBUTE_BLOCK and MPI_DISTRIBUTE_CYCLIC are equivalent.

MPI_DISTRIBUTE_NONE is equivalent to MPI_DISTRIBUTE_CYCLIC with array_of_dargs[i] set to array_of_gsizes[i].

Finally, MPI_DISTRIBUTE_CYCLIC with array_of_dargs[i] equal to MPI_DISTRIBUTE_DFLT_DARG is equivalent to MPI_DISTRIBUTE_CYCLIC with array_of_dargs[i] set to 1.

For MPI_ORDER_FORTRAN, an ndims-dimensional distributed array ( newtype) is defined by the following code fragment:

For MPI_ORDER_C, the code is:

where `r[i]` is the position of the process (with rank rank)
in the process grid at dimension `i`.
The values of `r[i]` are given by the following code fragment:

Let the typemap of oldtype have the form:
where
is a predefined MPI datatype, and let *ex* be the
extent of oldtype.
The following function uses the conceptual datatypes lb_marker
and ub_marker, see Section Lower-Bound and Upper-Bound Markers for details.

Given the above, the function cyclic() is defined as follows:

where *count* is defined by this code fragment:

Here, `nblocks` is the number of blocks that must be
distributed among the processors.
Finally,
is defined by this code fragment:

** Example**
Consider generating the filetypes corresponding to the HPF distribution:

This can be achieved by the following Fortran code, assuming there will be six processes attached to the run:

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