17.2.170. MPI_Get_elements

MPI_Get_elements, MPI_Get_elements_x - 返回数据类型中的基本元素数量。

17.2.170.1. 语法

17.2.170.1.1. C语法

#include <mpi.h>

int MPI_Get_elements(const MPI_Status *status, MPI_Datatype datatype,
    int *count)

int MPI_Get_elements_x(const MPI_Status *status, MPI_Datatype datatype,
    MPI_Count *count)

17.2.170.1.2. Fortran语法

USE MPI
! or the older form: INCLUDE 'mpif.h'

MPI_GET_ELEMENTS(STATUS, DATATYPE, COUNT, IERROR)
    INTEGER STATUS(MPI_STATUS_SIZE), DATATYPE, COUNT, IERROR

MPI_GET_ELEMENTS_X(STATUS, DATATYPE, COUNT, IERROR)
    INTEGER STATUS(MPI_STATUS_SIZE), DATATYPE
        INTEGER(KIND=MPI_COUNT_KIND) COUNT
        INTEGER IERROR

17.2.170.1.3. Fortran 2008 语法

USE mpi_f08

MPI_Get_elements(status, datatype, count, ierror)
    TYPE(MPI_Status), INTENT(IN) :: status
    TYPE(MPI_Datatype), INTENT(IN) :: datatype
    INTEGER, INTENT(OUT) :: count
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

MPI_Get_elements_x(status, datatype, count, ierror)
    TYPE(MPI_Status), INTENT(IN) :: status
    TYPE(MPI_Datatype), INTENT(IN) :: datatype
    INTEGER(KIND = MPI_COUNT_KIND), INTENT(OUT) :: count
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.170.2. 输入参数

  • status : 返回接收操作的状态(status)。

  • datatype : 接收操作使用的数据类型（句柄）。

17.2.170.3. 输出参数

  • ierror : 仅限Fortran：错误状态（整数）。

17.2.170.4. 描述

MPI_Get_elements 和 MPI_Get_elements_x 的行为与 MPI_Get_count 不同，后者返回接收到的"顶层条目"数量， 即数据类型 datatype 的"副本"数量。MPI_Get_count 可能返回 任意整数值 k，其中 0 ≤ k ≤ count。如果 MPI_Get_count 返回 k， 那么接收到的基本元素数量（以及 MPI_Get_elements 和 MPI_Get_elements_x 的返回值） 是 n × k，其中 n 是数据类型 datatype 类型映射中的基本元素数量。如果接收到的 基本元素数量不是 n 的倍数，也就是说，如果接收操作没有接收到整数个 数据类型"副本"，那么 MPI_Get_count 将返回 MPI_UNDEFINED 值。对于这两个函数， 如果 count 参数无法表示要返回的值（例如，如果参数太小而无法容纳输出值）， 则将其设置为 MPI_UNDEFINED。

示例：MPI_Get_count 和 MPI_Get_elements 的用法：

call MPI_TYPE_CONTIGUOUS(2, MPI_REAL, Type2, ierr)
call MPI_TYPE_COMMIT(Type2, ierr)
call MPI_COMM_RANK(comm, rank, ierr)

IF ( rank == 0 ) THEN
   CALL MPI_SEND(a, 2, MPI_REAL, 1, 0, comm, ierr)
   CALL MPI_SEND(a, 3, MPI_REAL, 1, 0, comm, ierr)
ELSE
   CALL MPI_RECV(a, 2, Type2, 0, 0, comm, stat, ierr)
   CALL MPI_GET_COUNT(stat, Type2, i, ierr) ! returns i=1
   CALL MPI_GET_ELEMENTS(stat, Type2, i, ierr) ! returns i=2
   CALL MPI_RECV(a, 2, Type2, 0, 0, comm, stat, ierr)
   CALL MPI_GET_COUNT(stat, Type2, i, ierr) ! returns i=MPI_UNDEFINED
   CALL MPI_GET_ELEMENTS(stat, Type2, i, ierr)  ! returns i=3
END IF

函数 MPI_Get_elements 也可在探测操作后使用，用于查找探测消息中的元素数量。请注意，当用于基本数据类型时，函数 MPI_Get_count 和 MPI_Get_elements 会返回相同的值。

17.2.170.5. 错误

几乎所有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不保证MPI程序在出现错误后能够继续运行。

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

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

另请参阅

MPI_Get_count