Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 1.7 KB

MPI_Group_translate_ranks.3.rst

File metadata and controls

77 lines (50 loc) · 1.7 KB
Raw

MPI_Group_translate_ranks

:ref:`MPI_Group_translate_ranks` |mdash| Translates the ranks of processes in one group to those in another group.

SYNTAX

C Syntax

#include <mpi.h>

int MPI_Group_translate_ranks(MPI_Group group1, int n,
     const int ranks1[], MPI_Group group2, int ranks2[])

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_GROUP_TRANSLATE_RANKS(GROUP1, N, RANKS1, GROUP2, RANKS2,
             IERROR)
     INTEGER GROUP1, N, RANKS1(*), GROUP2, RANKS2(*), IERROR

Fortran 2008 Syntax

USE mpi_f08
MPI_Group_translate_ranks(group1, n, ranks1, group2, ranks2, ierror)
     TYPE(MPI_Group), INTENT(IN) :: group1, group2
     INTEGER, INTENT(IN) :: n, ranks1(n)
     INTEGER, INTENT(OUT) :: ranks2(n)
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT PARAMETERS

  • group1: First group (handle).
  • n: Number of ranks in ranks1 and ranks2 arrays (integer).
  • ranks1: Array of zero or more valid ranks in group1.
  • group2: Second group (handle).

OUTPUT PARAMETERS

  • ranks2: Array of corresponding ranks in group2, MPI_UNDEFINED when no correspondence exists.
  • ierror: Fortran only: Error status (integer).

DESCRIPTION

This function is important for determining the relative numbering of the same processes in two different groups. For instance, if one knows the ranks of certain processes in the group of MPI_COMM_WORLD, one might want to know their ranks in a subset of that group.

ERRORS