2014-10-24 01:21:54 +04:00
.\" -*- nroff -*-
2010-10-08 01:13:11 +04:00
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
.\" Copyright 2006-2008 Sun Microsystems, Inc.
2006-09-28 22:39:36 +04:00
.\" Copyright (c) 1996 Thinking Machines Corporation
2014-10-24 01:21:54 +04:00
.\" $COPYRIGHT$
2008-08-02 01:14:37 +04:00
.TH MPI_Comm_remote_group 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
2006-09-28 22:39:36 +04:00
.SH NAME
\fBMPI_Comm_remote_group \fP \- Accesses the remote group associated with an intercommunicator.
.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Comm_remote_group(MPI_Comm \fIcomm\fP, MPI_Group\fI *group\fP)
2010-10-08 01:13:11 +04:00
.fi
2006-09-28 22:39:36 +04:00
.SH Fortran Syntax
.nf
2015-05-15 12:20:35 +03:00
USE MPI
! or the older form: INCLUDE 'mpif.h'
2006-09-28 22:39:36 +04:00
MPI_COMM_REMOTE_GROUP(\fICOMM, GROUP, IERROR\fP)
2015-06-24 06:59:57 +03:00
INTEGER \fICOMM, GROUP, IERROR\fP
2006-09-28 22:39:36 +04:00
2015-05-15 12:20:35 +03:00
.fi
.SH Fortran 2008 Syntax
.nf
USE mpi_f08
MPI_Comm_remote_group(\fIcomm\fP, \fIgroup\fP, \fIierror\fP)
TYPE(MPI_Comm), INTENT(IN) :: \fIcomm\fP
TYPE(MPI_Group), INTENT(OUT) :: \fIgroup\fP
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
2010-10-08 01:13:11 +04:00
.fi
2006-09-28 22:39:36 +04:00
.SH C++ Syntax
.nf
#include <mpi.h>
Group Intercomm::Get_remote_group() const
2010-10-08 01:13:11 +04:00
.fi
2006-09-28 22:39:36 +04:00
.SH INPUT PARAMETER
.ft R
.TP 1i
comm
Communicator.
.SH OUTPUT PARAMETERS
.ft R
.TP 1i
group
Remote group of communicator.
.ft R
.TP 1i
IERROR
2015-06-24 06:59:57 +03:00
Fortran only: Error status (integer).
2006-09-28 22:39:36 +04:00
.SH DESCRIPTION
.ft R
MPI_Comm_remote_group accesses the remote group associated with an intercommunicator.
.sp
The intercommunicator accessors (MPI_Comm_test_inter, MPI_Comm_remote_size,
MPI_Comm_remote_group) are all local operations.
.SH ERRORS
2010-07-22 05:24:12 +04:00
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.
2006-09-28 22:39:36 +04:00
.sp
Before the error value is returned, the current MPI error handler is
2015-06-24 06:59:57 +03:00
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.
2006-09-28 22:39:36 +04:00
.SH SEE ALSO
.sp
.nf
MPI_Comm_test_inter
MPI_Comm_remote_size
MPI_Intercomm_create
MPI_Intercomm_merge