MPICommgroup(3OpenMPI) MPICommgroup(3OpenMPI)

NAME
       MMPPIICCoommmmggrroouupp  - Returns the group associated with a communicator.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPICommgroup(MPIComm comm, MPIGroup *group)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPICOMMGROUP(COMM, GROUP, IERROR)
            INTEGER   COMM, GROUP, IERROR


CC++++ SSyynnttaaxx
       #include 
       Group Comm::Getgroup() const


IINNPPUUTT PPAARRAAMMEETTEERR
       comm      Communicator.


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       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 MPICommremotegroup func-
       tion.


EERRRROORRSS
       Almost all MPI routines return an error value; C routines as the  value
       of  the  function  and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default  error  handler  is  set  to
       MPI::ERRORSTHROWEXCEPTIONS, 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
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       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.




Open MPI 1.2                    September 2006        MPICommgroup(3OpenMPI)