bionic (3) MPI_Comm_remote_size.openmpi.3.gz

Provided by: openmpi-doc_2.1.1-8_all bug

NAME

       MPI_Comm_remote_size  - Determines the size of the remote group associated with an intercommunicator.

SYNTAX

C Syntax

       #include <mpi.h>
       int MPI_Comm_remote_size(MPI_Comm comm, int *size)

Fortran Syntax

       INCLUDE 'mpif.h'
       MPI_COMM_REMOTE_SIZE(COMM, SIZE, IERROR)
            INTEGER   COMM, SIZE, IERROR

C++ Syntax

       #include <mpi.h>
       int Intercomm::Get_remote_size() const

INPUT PARAMETER

       comm      Communicator (handle).

OUTPUT PARAMETERS

       size      Number of processes in the remote group of comm (integer).

       IERROR    Fortran only: Error status (integer).

DESCRIPTION

       MPI_Comm_remote_size determines the size of the remote group associated with an intercommunicator.

       The   intercommunicator  accessors (MPI_Comm_test_inter, MPI_Comm_remote_size, MPI_Comm_remote_group) are
       all local operations.

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.

SEE ALSO

       MPI_Comm_test_inter
       MPI_Comm_remote_group
       MPI_Intercomm_create
       MPI_Intercomm_merge