1MPI_Group_rank(3)                   LAM/MPI                  MPI_Group_rank(3)
2
3
4

NAME

6       MPI_Group_rank -  Returns the rank of this process in the given group
7

SYNOPSIS

9       #include <mpi.h>
10       int
11       MPI_Group_rank(MPI_Group group, int *prank)
12

INPUT PARAMETERS

14       group  - group (handle)
15
16

OUTPUT PARAMETER

18       rank   - rank of the calling process in group (integer)
19
20

NOTES FOR FORTRAN

22       All  MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
23       an additional argument ierr at the end of the argument list.   ierr  is
24       an  integer and has the same meaning as the return value of the routine
25       in C.  In Fortran, MPI routines are subroutines, and are  invoked  with
26       the call statement.
27
28       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
29       Fortran.
30
31

ERRORS

33       If an error occurs in an MPI function, the current MPI error handler is
34       called  to  handle  it.   By default, this error handler aborts the MPI
35       job.  The error handler may be changed with  MPI_Errhandler_set  ;  the
36       predefined  error  handler MPI_ERRORS_RETURN may be used to cause error
37       values to be returned (in C and Fortran; this  error  handler  is  less
38       useful  in  with  the  C++  MPI bindings.  The predefined error handler
39       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the  error  value
40       needs  to  be recovered).  Note that MPI does not guarantee that an MPI
41       program can continue past an error.
42
43       All MPI routines (except MPI_Wtime and  MPI_Wtick  )  return  an  error
44       value;  C routines as the value of the function and Fortran routines in
45       the last argument.  The C++ bindings for MPI do not return  error  val‐
46       ues;  instead,  error values are communicated by throwing exceptions of
47       type MPI::Exception (but not by default).  Exceptions are  only  thrown
48       if the error value is not MPI::SUCCESS .
49
50
51       Note  that  if  the MPI::ERRORS_RETURN handler is set in C++, while MPI
52       functions will return upon an error, there will be no  way  to  recover
53       what the actual error value was.
54       MPI_SUCCESS
55              - No error; MPI routine completed successfully.
56       MPI_ERR_GROUP
57              - Null group passed to function.
58       MPI_ERR_ARG
59              - Invalid argument.  Some argument is invalid and is not identi‐
60              fied by a specific  error  class.   This  is  typically  a  NULL
61              pointer or other such error.
62
63

MORE INFORMATION

65       For more information, please see the official MPI Forum web site, which
66       contains the text of both the MPI-1 and MPI-2 standards.   These  docu‐
67       ments  contain  detailed  information  about each MPI function (most of
68       which is not duplicated in these man pages).
69
70       http://www.mpi-forum.org/
71
72
73

ACKNOWLEDGEMENTS

75       The LAM Team would like the thank the MPICH Team for the handy  program
76       to  generate  man  pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
77       ing/sowing.tar.gz ), the initial formatting, and some initial text  for
78       most of the MPI-1 man pages.
79

LOCATION

81       grank.c
82
83
84
85LAM/MPI 7.1.2                      2/23/2006                 MPI_Group_rank(3)