17.2.393. MPI_Type_create_subarray

MPI_Type_create_subarray — 创建一个描述n维数组中n维子数组的数据类型。

17.2.393.1. 语法

17.2.393.1.1. C语法

#include <mpi.h>

int MPI_Type_create_subarray(int ndims, const int array_of_sizes[],
    const int array_of_subsizes[], const int array_of_starts[],
    int order, MPI_Datatype oldtype, MPI_Datatype *newtype)

17.2.393.1.2. Fortran语法

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_TYPE_CREATE_SUBARRAY(NDIMS, ARRAY_OF_SIZES, ARRAY_OF_SUBSIZES,
     ARRAY_OF_STARTS, ORDER, OLDTYPE, NEWTYPE, IERROR)

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

17.2.393.1.3. Fortran 2008 语法

USE mpi_f08
MPI_Type_create_subarray(ndims, array_of_sizes, array_of_subsizes,
             array_of_starts, order, oldtype, newtype, ierror)
     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

17.2.393.2. 输入参数

ndims: 数组维度数（正整数）。
array_of_sizes: 完整数组每个维度中oldtype类型的元素数量（正整数数组）。
array_of_subsizes: 子数组每个维度中oldtype类型的元素数量（正整数数组）。
array_of_starts: 子数组在每个维度中的起始坐标（非负整数数组）。
order: 数组存储顺序标志（状态）。
oldtype: 数组元素数据类型（句柄）。

17.2.393.3. 输出参数

newtype: 新数据类型（句柄）。
ierror: 仅限Fortran：错误状态（整数）。

17.2.393.4. 描述

子数组类型构造函数创建了一个MPI数据类型，用于描述一个n维数组中的n维子数组。该子数组可以位于完整数组中的任何位置，只要它被限制在这个数组内，其大小可以是任何非零值，最大可达较大数组的尺寸。这个类型构造函数有助于创建文件类型，用于访问分布在多个进程中的块状数组，这些数组被写入包含全局数组的单个文件中。

该类型构造函数可以处理任意维度的数组，并适用于C语言和Fortran语言排序的矩阵（即行优先或列优先）。需要注意的是，C程序可能使用Fortran排序方式，而Fortran程序也可能使用C排序方式。

ndims 参数指定完整数据数组的维度数量，并给出 array_of_sizes、array_of_subsizes 和 array_of_starts 中的元素个数。

在n维数组中，每个维度的oldtype类型元素数量以及请求的子数组分别由array_of_sizes和array_of_subsizes指定。对于任何维度i，若指定array_of_subsizes[i] < 1 或 array_of_subsizes[i] > array of sizes[i] 都是错误的。

array_of_starts数组包含子数组每个维度的起始坐标。数组索引默认从零开始。对于任何维度i，指定以下情况是错误的

array_of_starts[i] < 0

或

array_of_starts[i] > (array_of_sizes[i] - array_of_subsizes[i]).

order参数指定了子数组以及完整数组的存储顺序。它必须设置为以下选项之一：

MPI_ORDER_C: C语言数组使用的排序方式（即行优先顺序）
MPI_ORDER_FORTRAN: Fortran数组使用的排序方式（即列主序）

一个ndims维的子数组(newtype)，不带额外填充，可以通过Subarray()函数定义如下：

newtype = Subarray(ndims, {size_0, size_1,..., size_ndims-1},
          {subsize_0, subsize_1, ..., subsize_ndims-1},
          {start_0, start_1, ..., start_ndims-1}, oldtype)

让oldtype的类型映射具有以下形式：

{(type_0, disp_0), (type_1, disp_1), ..., (type_n-1, disp_n-1)}

其中typei是预定义的MPI数据类型，ex表示oldtype的跨度。

Subarray()函数在MPI-2标准第72页通过三个递归方程定义。

关于在I/O上下文中使用MPI_Type_create_subarray的示例，请参阅MPI-2标准第9.9.2节。

17.2.393.5. 备注

在Fortran程序中，如果数组的索引从1开始，且子数组某一维度的起始坐标为n，则该维度起始坐标数组中的对应项为n-1。

17.2.393.6. 错误

几乎所有MPI例程都会返回一个错误值；C语言例程通过函数返回值返回，Fortran例程则通过最后一个参数返回。

在返回错误值之前，会调用与通信对象（如通信器、窗口、文件）关联的当前MPI错误处理程序。如果MPI调用未关联任何通信对象，则该调用被视为附加到MPI_COMM_SELF，并将调用关联的MPI错误处理程序。当MPI_COMM_SELF未初始化时（即在MPI_Init/MPI_Init_thread之前、MPI_Finalize之后，或仅使用会话模型时），错误会触发初始错误处理程序。初始错误处理程序可通过在使用世界模型时调用MPI_Comm_set_errhandler来修改MPI_COMM_SELF，或通过mpiexec的mpi_initial_errhandler命令行参数，或MPI_Comm_spawn/MPI_Comm_spawn_multiple的info键来设置。如果未设置其他适当的错误处理程序，则MPI I/O函数将调用MPI_ERRORS_RETURN错误处理程序，而其他所有MPI函数将调用MPI_ERRORS_ABORT错误处理程序。

Open MPI 包含三个可使用的预定义错误处理器：

MPI_ERRORS_ARE_FATAL 导致程序中止所有连接的MPI进程。
MPI_ERRORS_ABORT 一个可在通信器、窗口、文件或会话上调用的错误处理程序。当在通信器上调用时，其行为类似于在该通信器上调用MPI_Abort。如果在窗口或文件上调用，则行为类似于在包含对应窗口或文件中进程组的通信器上调用MPI_Abort。如果在会话上调用，则仅中止本地进程。
MPI_ERRORS_RETURN 向应用程序返回一个错误代码。

MPI应用程序也可以通过调用以下方式实现自己的错误处理程序：

MPI_Comm_create_errhandler 然后 MPI_Comm_set_errhandler
MPI_File_create_errhandler 然后 MPI_File_set_errhandler
MPI_Session_create_errhandler 然后 MPI_Session_set_errhandler 或在 MPI_Session_init
MPI_Win_create_errhandler 然后 MPI_Win_set_errhandler

请注意，MPI不保证MPI程序在出现错误后能够继续运行。

查看MPI手册页获取完整的MPI错误代码列表。

有关更多信息，请参阅MPI-3.1标准中的错误处理部分。