File: MPI_Bsend_init.3.rst

package info (click to toggle)
openmpi 5.0.9-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 201,956 kB
  • sloc: ansic: 614,602; makefile: 42,354; sh: 11,194; javascript: 9,244; f90: 7,052; java: 6,404; perl: 5,192; python: 1,862; lex: 740; fortran: 61; cpp: 20; tcl: 12
file content (81 lines) | stat: -rw-r--r-- 1,886 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
.. _mpi_bsend_init:

MPI_Bsend_init
==============

.. include_body

:ref:`MPI_Bsend_init` |mdash| Builds a handle for a buffered send.

SYNTAX
------

C Syntax
^^^^^^^^

.. code-block:: C

   #include <mpi.h>

   int MPI_Bsend_init(const void *buf, int count, MPI_Datatype datatype,
       int dest, int tag, MPI_Comm comm, MPI_Request *request)

Fortran Syntax
^^^^^^^^^^^^^^

.. code-block:: Fortran

   USE MPI
   ! or the older form: INCLUDE 'mpif.h'

   MPI_BSEND_INIT(BUF, COUNT, DATATYPE, DEST, TAG, COMM, REQUEST, IERROR)
       <type>  BUF(*)
       INTEGER COUNT, DATATYPE, DEST, TAG,
       INTEGER COMM, REQUEST, IERROR

Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^

.. code-block:: Fortran

   USE mpi_f08

   MPI_Bsend_init(buf, count, datatype, dest, tag, comm, request, ierror)
       TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: buf
       INTEGER, INTENT(IN) :: count, dest, tag
       TYPE(MPI_Datatype), INTENT(IN) :: datatype
       TYPE(MPI_Comm), INTENT(IN) :: comm
       TYPE(MPI_Request), INTENT(OUT) :: request
       INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT PARAMETERS
----------------

* ``buf`` : Initial address of send buffer (choice).
* ``count`` : Number of elements sent (integer).
* ``datatype`` : Type of each element (handle).
* ``dest`` : Rank of destination (integer).
* ``tag`` : Message tag (integer).
* ``comm`` : Communicator (handle).

OUTPUT PARAMETERS
-----------------

* ``request`` : Communication request (handle).
* ``ierror`` : Fortran only: Error status (integer).

DESCRIPTION
-----------

Creates a persistent communication request for a buffered mode send, and
binds to it all the arguments of a send operation.

A communication (send or receive) that uses a persistent request is
initiated by the function :ref:`MPI_Start`.

ERRORS
------

.. include:: ./ERRORS.rst

.. seealso:: :ref:`MPI_Send_init` :ref:`MPI_Start`