Open MPI logo

MPI_Comm_group(3) man page (version 1.8.1)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

MPI_Comm_group - Returns the group associated with a communicator.

Syntax

C Syntax


#include <mpi.h>
int MPI_Comm_group(MPI_Comm comm, MPI_Group *group)

Fortran Syntax


INCLUDE ’mpif.h’
MPI_COMM_GROUP(COMM, GROUP, IERROR)
      INTEGER    COMM, GROUP, IERROR

C++ Syntax


#include <mpi.h>
Group Comm::Get_group() const

Input Parameter

comm
Communicator.

Output Parameters

group
Group in communicator (handle).
IERROR
Fortran only: Error status (integer).

Description

If the communicator is an intercommunicator (enables communication between two groups of processes), this function returns the local group. To return the remote group, use the MPI_Comm_remote_group function.

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.

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.


Table of Contents

« Return to documentation listing