Lockless Inc

NAME

MPI_Group_rank - Returns the current rank within the given group

SYNOPSIS

#include <mpi.h> int MPI_Group_rank(MPI_Group group , int *rank );

#include <pmpi.h> int PMPI_Group_rank(MPI_Group group , int *rank );

#include <mpi.h> int MPI::Group::Get_rank(void) const;

INCLUDE 'mpif.h' MPI_GROUP_RANK(group , rank , ierr ) INTEGER group , rank , ierr

INPUT PARAMETER

group - group (handle)

OUTPUT PARAMETER

rank - the current processes rank within the group (integer).

DESCRIPTION

The MPI_Group_rank() function is used to obtain the current rank within the given group. If the process does not belong to the group, then MPI_UNDEFINED is returned.

In C++, the rank number is passed as the return value.

The group must be a valid one (not MPI_Group_NULL). PMPI_Group_rank() is the profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.

MPI_SUCCESS - No error;

MPI_ERR_PENDING - Pending exception;

MPI_ERR_GROUP - Invalid group;

MPI_ERR_ARG - Invalid output pointer.

SEE ALSO

MPI_Comm_rank (3) MPI_Group_size (3) MPI_Group_translate_ranks (3)

About Us Returns Policy Privacy Policy Send us Feedback
Company Info | Product Index | Category Index | Help | Terms of Use
Copyright © Lockless Inc All Rights Reserved.