Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_recv_init(3openmpi) [osx man page]

MPI_Recv_init(3OpenMPI) 												   MPI_Recv_init(3OpenMPI)

NAME
MPI_Recv_init - Builds a handle for a receive. SYNTAX
C Syntax #include <mpi.h> int MPI_Recv_init(void *buf, int count, MPI_Datatype datatype, int source, int tag, MPI_Comm comm, MPI_Request *request) Fortran Syntax INCLUDE 'mpif.h' MPI_RECV_INIT(BUF, COUNT, DATATYPE, SOURCE, TAG, COMM, REQUEST, IERROR) <type> BUF(*) INTEGER COUNT, DATATYPE, SOURCE, TAG, COMM, REQUEST, IERROR C++ Syntax #include <mpi.h> Prequest Comm::Recv_init(void* buf, int count, const Datatype& datatype, int source, int tag) const INPUT PARAMETERS
count Maximum number of elements to receive (integer). datatype Type of each entry (handle). source Rank of source (integer). tag Message tag (integer). comm Communicator (handle). INPUT
/OUTPUT PARAMETER buf Initial address of receive buffer (choice). OUTPUT PARAMETERS
request Communication request (handle). IERROR Fortran only: Error status (integer). DESCRIPTION
Creates a persistent communication request for a receive operation. The argument buf is marked as OUT because the user gives permission to write on the receive buffer by passing the argument to MPI_Recv_init. A persistent communication request is inactive after it is created -- no active communication is attached to the request. A communication (send or receive) that uses a persistent request is initiated by the function MPI_Start or MPI_Startall. 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++ func- tions 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_Bsend_init MPI_Rsend_init MPI_Send_init MPI_Sssend_init MPI_Start MPI_Startall MPI_Request_free Open MPI 1.2 September 2006 MPI_Recv_init(3OpenMPI)

Check Out this Related Man Page

MPI_Rsend(3OpenMPI)													       MPI_Rsend(3OpenMPI)

NAME
MPI_Rsend - Ready send. SYNTAX
C Syntax #include <mpi.h> int MPI_Rsend(void *buf, int count, MPI_Datatype datatype, int dest, int tag, MPI_Comm comm) Fortran Syntax INCLUDE 'mpif.h' MPI_RSEND(BUF, COUNT, DATATYPE, DEST, TAG, COMM, IERROR) <type> BUF(*) INTEGER COUNT, DATATYPE, DEST, TAG, COMM, IERROR C++ Syntax #include <mpi.h> void Comm::Rsend(const void* buf, int count, const Datatype& datatype, int dest, int tag) const INPUT PARAMETERS
buf Initial address of send buffer (choice). count Number of elements in send buffer (nonnegative integer). datatype Datatype of each send buffer element (handle). dest Rank of destination (integer). tag Message tag (integer). comm Communicator (handle). OUTPUT PARAMETER
IERROR Fortran only: Error status (integer). DESCRIPTION
A ready send may only be called if the user can guarantee that a receive is already posted. It is an error if the receive is not posted before the ready send is called. 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++ func- tions 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. Open MPI 1.2 September 2006 MPI_Rsend(3OpenMPI)
Man Page