Open MPI logo

MPI_Send(3) man page (version 1.8)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

MPI_Send - Performs a standard-mode blocking send.

Syntax

C Syntax


#include <mpi.h>
int MPI_Send(const void *buf, int count, MPI_Datatype datatype, int dest,
    int tag, MPI_Comm comm)

Fortran Syntax


INCLUDE ’mpif.h’
MPI_SEND(BUF, COUNT, DATATYPE, DEST, TAG, COMM, IERROR)
    <type>    BUF(*)
    INTEGER    COUNT, DATATYPE, DEST, TAG, COMM, IERROR

C++ Syntax


#include <mpi.h>
void Comm::Send(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 send (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

MPI_Send performs a standard-mode, blocking send.

Note

This routine will block until the message is sent to the destination. For an in-depth explanation of the semantics of the standard-mode send, refer to the MPI-1 Standard.

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_Isend
MPI_Bsend
MPI_Recv

« Return to documentation listing