MPI_Recv - Provides a basic receive operation


SYNOPSIS

       C:

            #include <mpi.h>

            int MPI_Recv( buf, count, datatype, source,
            tag, comm, status )
            void             *buf;
            int              count, source, tag;
            MPI_Datatype     datatype;
            MPI_Comm         comm;
            MPI_Status       *status;

       C++:

            #include <mpi.h>

            void Comm::Recv(
            void*             buf,
            int               count,
            const Datatype&   datatype,
            int               source,
            int               tag) const

       Fortran:

            INCLUDE "mpif.h" (or USE MPI)

            <type> BUF(*)
            INTEGER count, datatype, source, tag, comm,
            status(MPI_STATUS_SIZE), ierror

            CALL MPI_RECV(buf, count, datatype, source, tag, comm,
            status(MPI_STATUS_SIZE), ierror)


STANDARDS

       This release implements the MPI 1.2 standard, as
       documented by the MPI Forum in the spring 1997 release of
       MPI:  A Message Passing Interface Standard.


DESCRIPTION

       The MPI_Recv routine provides a basic receive operation.
       This routine accepts the following parameters:

       buf       Returns the initial address of the receive
                 buffer (choice)

       status    Returns the status object (status)

                 receive buffer (integer)

       datatype  Specifies the data type of each receive buffer
                 element (handle)

       source    Specifies the rank of the source (integer)

       tag       Specifies the message tag (integer)

       comm      Specifies the communicator (handle)

       ierror    Specifies the return code value for successful
                 completion, which is in MPI_SUCCESS.
                 MPI_SUCCESS is defined in the mpif.h file.


NOTES

       The count parameter indicates the maximum length of a
       message; you can determine the actual number by using
       MPI_Get_count.

       All Fortran MPI routines (except for MPI_Wtime(3) and
       MPI_Wtick(3)) have an additional ierr argument at the end
       of the argument list.  ierr is an integer and has the same
       meaning as the return value of the routine in C.  In
       Fortran, MPI routines are subroutines and are invoked with
       the CALL statement.  Additionally, all MPI objects (for
       example, MPI_Datatype and MPI_Comm) are of type integer.


SEE ALSO

       MPI_Irecv(3), MPI_Get_count(3), MPI_Wtime(3), MPI_Wtick(3)


Man(1) output converted with man2html