MPI_Comm_remote_group(3)

NAME
MPI_Comm_remote_group - Returns the remote group of a intercommunicator

SYNOPSIS
#include <mpi.h>
int MPI_Comm_remote_group(MPI_Comm comm, int *group);

#include <pmpi.h>
int PMPI_Comm_remote_group(MPI_Comm comm, int *group);

#include <mpi.h>
MPI::Group MPI::Intercomm::Get_remote_group(void) const;

INCLUDE 'mpif.h'
MPI_COMM_REMOTE_GROUP(comm, group, ierr)
INTEGER comm, group, ierr

INPUT PARAMETER
comm
    - intercommunicator (handle)

OUTPUT PARAMETER
group
    - the remote group of the intercommunicator (handle).

DESCRIPTION
The MPI_Comm_remote_group() function is used to obtain the remote group of the intercommunicator. This group should eventually be freed via the MPI_Group_free() function. In C++, the group is passed as the return value. The intercommunicator must be a valid one (not MPI_COMM_NULL). PMPI_Comm_remote_group() 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_COMM
    - Invalid intercommunicator;
MPI_ERR_ARG
    - Invalid output pointer.

SEE ALSO
MPI_Comm_group(3), MPI_Comm_rank(3), MPI_Comm_remote_size(3), MPI_Group_free(3)