MPICommrank(3OpenMPI) MPICommrank(3OpenMPI)

NAME
       MMPPIICCoommmmrraannkk  - Determines the rank of the calling process in the com-
       municator.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPICommrank(MPIComm comm, int *rank)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPICOMMRANK(COMM, RANK, IERROR)
            INTEGER   COMM, RANK, IERROR


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


IINNPPUUTT PPAARRAAMMEETTEERRSS
       comm      Communicator (handle).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       rank      Rank of the calling process in group of comm (integer).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       This function gives the rank of the process in the particular  communi-
       cator's  group.  It is equivalent to accessing the communicator's group
       with MPICommgroup, computing the rank using MPIGrouprank, and  then
       freeing the temporary group via MPIGroupfree.

       Many  programs  will  be written with the master-slave model, where one
       process (such as the rank-zero process) will play a  supervisory  role,
       and the other processes will serve as compute nodes. In this framework,
       MPICommsize and MPICommrank are useful for determining the roles of
       the various processes of a communicator.


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.


SEE ALSO
       MPICommgroup
       MPICommsize
       MPICommcompare




Open MPI 1.2                    September 2006         MPICommrank(3OpenMPI)