Edit

Share via


MPI_Group_rank function

Returns the rank of the calling process in the specified group.

Syntax

int MPIAPI MPI_Group_rank(
        MPI_Group group,
  _Out_ int       *rank
);

Parameters

  • group
    Specifies the group to query.

  • rank [out]
    A pointer to an integer that, on return, contains the rank of the calling process in the specified group. A value of MPI_UNDEFINED that the calling process is not a member of the specified group.

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_GROUP_RANK(GROUP, RANK, IERROR)
        INTEGER GROUP, RANK, IERROR 

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 Group Functions