Skip to content

Latest commit

 

History

History
104 lines (73 loc) · 2.62 KB

MPI_Mrecv.3.rst

File metadata and controls

104 lines (73 loc) · 2.62 KB
Raw

MPI_Mrecv

MPI_Mrecv Blocking receive for a matched message

SYNTAX

C Syntax

#include <mpi.h>

int MPI_Mrecv(void *buf, int count, MPI_Datatype type,
 MPI_Message *message, MPI_Status *status)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_MRECV(BUF, COUNT, DATATYPE, MESSAGE, STATUS, IERROR)
 <type>  BUF(*)
 INTEGER COUNT, DATATYPE, MESSAGE
 INTEGER STATUS(MPI_STATUS_SIZE), IERROR

Fortran 2008 Syntax

USE mpi_f08
MPI_Mrecv(buf, count, datatype, message, status, ierror)
 TYPE(*), DIMENSION(..) :: buf
 INTEGER, INTENT(IN) :: count
 TYPE(MPI_Datatype), INTENT(IN) :: datatype
 TYPE(MPI_Message), INTENT(INOUT) :: message
 TYPE(MPI_Status) :: status
 INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT PARAMETERS

  • count: Number of elements to receive (nonnegative integer).
  • datatype: Datatype of each send buffer element (handle).
  • message: Message (handle).

OUTPUT PARAMETERS

  • buf: Initial address of receive buffer (choice).
  • status: Status object (status).
  • ierror: Fortran only: Error status (integer).

DESCRIPTION

The functions MPI_Mrecv and MPI_Imrecv receive messages that have been previously matched by a matching probe.

If MPI_Mrecv is called with MPI_MESSAGE_NULL as the message argument, the call returns immediately with the status object set to source = MPI_PROC_NULL, tag = MPI_ANY_TAG, and count = 0, as if a receive from MPI_PROC_NULL was issued.

If your application does not need to examine the status field, you can save resources by using the predefined constant MPI_STATUS_IGNORE as a special value for the status argument.

ERRORS

Note that per the "Return Status" section in the "Point-to-Point Communication" chapter in the MPI Standard, MPI errors on messages received by MPI_Mrecv do not set the status.MPI_ERROR field in the returned status. The error code is always passed to the back-end error handler and may be passed back to the caller through the return value of MPI_Mrecv if the back-end error handler returns it. The pre-defined MPI error handler MPI_ERRORS_RETURN exhibits this behavior, for example.

* MPI_Mprobe * MPI_Improbe * MPI_Probe * MPI_Iprobe * MPI_Imrecv * MPI_Cancel