MPIGrouprank(3OpenMPI) MPIGrouprank(3OpenMPI)

NAME
       MMPPIIGGrroouupprraannkk  -  Returns the rank of the calling process in the given
       group.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIGrouprank(MPIGroup group, int *rank)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIGROUPRANK(GROUP, RANK, IERROR)
            INTEGER   GROUP, RANK, IERROR


CC++++ SSyynnttaaxx
       #include 
       int Group::Getrank() const


IINNPPUUTT PPAARRAAMMEETTEERRSS
       group     Group (handle).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       rank      Rank of the calling process in group, or MPIUNDEFINED if the
                 process is not a member (integer).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPIGrouprank  returns  as  the  output parameter rank the rank of the
       calling process in group. If the process is not a member of group  then
       MPIUNDEFINED is returned.


EERRRROORRSS
       Almost  all MPI routines return an error value; C routines as the value
       of the function and Fortran routines in the last  argument.  C++  func-
       tions  do  not  return  errors.  If the default error handler is set to
       MPI::ERRORSTHROWEXCEPTIONS, then on error the C++ exception mechanism
       will be used to throw an MPI:Exception object.

       Before  the  error  value is returned, the current MPI error handler is
       called. By default, this error handler aborts the MPI job,  except  for
       I/O   function   errors.   The   error  handler  may  be  changed  with
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       may  be  used  to cause error values to be returned. Note that MPI does
       not guarantee that an MPI program can continue past an error.




Open MPI 1.2                    September 2006        MPIGrouprank(3OpenMPI)