Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 1.89 KB

MPI_Mrecv.3.rst

File metadata and controls

90 lines (61 loc) · 1.89 KB
Raw

MPI_Mrecv

:ref:`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 :ref:`MPI_Mrecv` and :ref:`MPI_Imrecv` receive messages that have been previously matched by a matching probe.

If :ref:`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.

ERRORS

.. seealso::
   * :ref:`MPI_Mprobe`
   * :ref:`MPI_Improbe`
   * :ref:`MPI_Probe`
   * :ref:`MPI_Iprobe`
   * :ref:`MPI_Imrecv`
   * :ref:`MPI_Cancel`