MPI_Cart_sub function

Partitions a communicator into subgroups which form lower-dimensional cartesian subgrids.

Syntax

int MPIAPI MPI_Cart_sub(
        MPI_Comm comm,
  _In_  int      *remain_dims,
  _Out_ MPI_Comm *newcomm
);

Parameters

• comm
  Communicator with cartesian structure.

• remain_dims [in]
  The i-th entry of remain_dims specifies whether the i-th dimension is kept in the subgrid (true) or is dropped (false).

• newcomm [out]
  Communicator containing the subgrid that includes the calling process.

Return value

Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.

In Fortran, the return value is stored in the IERROR parameter.

Fortran

    MPI_CART_SUB(COMM, REMAIN_DIMS, NEWCOMM, IERROR)
        INTEGER COMM, NEWCOMM, IERROR
        LOGICAL REMAIN_DIMS(*)

Requirements

Product	HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities
Header	Mpi.h; Mpif.h
Library	Msmpi.lib
DLL	Msmpi.dll

See also

MPI Process Topology Functions