openmpi/ompi/mpi/man/man3/MPI_Comm_rank.3

.\"Copyright 2006, Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.TH MPI_Comm_rank 3OpenMPI "September 2006" "Open MPI 1.2" " "
.SH NAME
\fBMPI_Comm_rank\fP \- Determines the rank of the calling process in the communicator.

.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Comm_rank(MPI_Comm \fIcomm\fP, int\fI *rank\fP)

.SH Fortran Syntax
.nf
INCLUDE 'mpif.h'
MPI_COMM_RANK(\fICOMM, RANK, IERROR\fP)
	INTEGER	\fICOMM, RANK, IERROR\fP 

.SH C++ Syntax
.nf
#include <mpi.h>
int Comm::Get_rank() const

.SH INPUT PARAMETERS
.ft R
.TP 1i
comm
Communicator (handle).

.SH OUTPUT PARAMETERS
.ft R
.TP 1i
rank
Rank of the calling process in group of comm (integer).
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer). 

.SH DESCRIPTION
.ft R
This function gives the rank of the process in the
particular communicator's group. It is equivalent to accessing the
communicator's group with MPI_Comm_group, computing the rank using MPI_Group_rank, and then freeing the temporary group via MPI_Group_free. 
.sp
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, MPI_Comm_size and MPI_Comm_rank are useful for determining the roles of the various processes of a communicator. 

.SH ERRORS
Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI:Exception object.
.sp
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 MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN 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.  

.SH SEE ALSO
.ft R
.sp
.nf
MPI_Comm_group
MPI_Comm_size
MPI_Comm_compare