MPI_TYPE_CREATE_SUBARRAY(ndims, array_of_sizes, array_of_subsizes, array_of_starts, order, oldtype, newtype) | |

IN ndims | number of array dimensions (positive integer) |

IN array_of_sizes | number of elements of type oldtype in each dimension of the full array (array of positive integers) |

IN array_of_subsizes | number of elements of type oldtype in each dimension of the subarray (array of positive integers) |

IN array_of_starts | starting coordinates of the subarray in each dimension (array of non-negative integers) |

IN order | array storage order flag (state) |

IN oldtype | old datatype (handle) |

OUT newtype | new datatype (handle) |

INTEGER, INTENT(IN) :: ndims, array_of_sizes(ndims), array_of_subsizes(ndims), array_of_starts(ndims), order

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

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

INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INTEGER, INTENT(IN) :: ndims, order

INTEGER(KIND=MPI_COUNT_KIND), INTENT(IN) :: array_of_sizes(ndims), array_of_subsizes(ndims), array_of_starts(ndims)

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

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

INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INTEGER NDIMS, ARRAY_OF_SIZES(*), ARRAY_OF_SUBSIZES(*), ARRAY_OF_STARTS(*), ORDER, OLDTYPE, NEWTYPE, IERROR

The subarray type constructor creates an MPI datatype
describing an
*n*-dimensional
subarray of an
*n*-dimensional
array.
The subarray may be situated anywhere within the full array,
and may be of any nonzero size up to the size of the larger array
as long as it is confined within this array.
This type constructor facilitates creating filetypes to access
arrays distributed in blocks among processes to a
single file that contains the global array,
see MPI I/O, especially Section Definitions.

This type constructor can handle arrays with an arbitrary number of dimensions and works for both C and Fortran ordered matrices (i.e., row-major or column-major). Note that a C program may use Fortran order and a Fortran program may use C order.

The ndims parameter specifies the number of dimensions in the full data array and gives the number of elements in array_of_sizes, array_of_subsizes, and array_of_starts.

The number of elements of type oldtype in
each dimension of the
*n*-dimensional
array and the
requested subarray are specified by
array_of_sizes and array_of_subsizes,
respectively.
For any dimension
i,
it is erroneous to specify
array_of_subsizes[i] *<* 1 or
array_of_subsizes[i] *>* array_of_sizes[i].

The array_of_starts contains the
starting coordinates of each
dimension of the subarray.
Arrays are assumed to be indexed starting from zero.
For any dimension *i*, it is erroneous to specify
array_of_starts[i] *<* 0 or
array_of_starts[i]
*>* ( array_of_sizes[i] *-* array_of_subsizes[i]).

* Advice to users.*

In a Fortran program with arrays indexed starting from 1,
if the starting coordinate of a particular dimension
of the subarray is n,
then the entry in array_of_starts
for that dimension is n-1.
(* End of advice to users.*)

The order argument specifies the storage order for the
subarray as well as the full array.
It must be set to one
of the following:

A ndims-dimensional subarray ( newtype) with no extra padding can be defined by the function Subarray() as follows:

Let the typemap of oldtype have the form:
where
is a predefined MPI datatype, and let *ex* be the
extent of oldtype. Then we define the Subarray() function
recursively using the following three equations.
Equation 2 defines the base step.
Equation 2 defines the recursion step when
order = MPI_ORDER_FORTRAN, and
Equation 2 defines the recursion step when
order = MPI_ORDER_C.
These equations use the conceptual datatypes lb_marker
and ub_marker; see Section Lower-Bound and Upper-Bound Markers for details.

For an example use of MPI_TYPE_CREATE_SUBARRAY in the context of I/O see Section Subarray Filetype 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