17.2.37. MPI_Cart_map

MPI_Cart_map — 将进程映射到笛卡尔拓扑信息。

17.2.37.1. 语法

17.2.37.1.1. C语法

#include <mpi.h>

int MPI_Cart_map(MPI_Comm comm, int ndims, const int dims[],
    const int periods[], int *newrank)

17.2.37.1.2. Fortran语法

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

MPI_CART_MAP(COMM, NDIMS, DIMS, PERIODS, NEWRANK, IERROR)
    INTEGER COMM, NDIMS, DIMS(*), NEWRANK, IERROR
    LOGICAL PERIODS(*)

17.2.37.1.3. Fortran 2008 语法

USE mpi_f08

MPI_Cart_map(comm, ndims, dims, periods, newrank, ierror)
    TYPE(MPI_Comm), INTENT(IN) :: comm
    INTEGER, INTENT(IN) :: ndims, dims(ndims)
    LOGICAL, INTENT(IN) :: periods(ndims)
    INTEGER, INTENT(OUT) :: newrank
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.37.2. 输入参数

comm : 输入通信器（句柄）。
ndims : 笛卡尔结构的维度数（整数）。
dims大小为ndims的整数数组，用于指定每个坐标方向上的进程数量
在每个坐标方向上。
periods大小为ndims的逻辑数组，用于指定周期性
在每个坐标方向上的规范。

17.2.37.3. 输出参数

newrank调用进程的重新排序后的等级；如果调用进程不属于网格则返回MPI_UNDEFINED
调用进程不属于网格（整型）。
ierror : 仅限Fortran：错误状态（整数）。

17.2.37.4. 描述

MPI_Cart_map 和 MPI_Graph_map 可用于实现所有其他拓扑函数。通常情况下，用户不会直接调用这些函数，除非他或她正在创建MPI提供的虚拟拓扑功能之外的额外功能。MPI_Cart_map 会计算调用进程在物理机器上的"最优"放置位置。该函数的一种可能实现方式是始终返回调用进程的秩，即不执行任何重新排序。

17.2.37.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_Graph_map