File: MPI_Get_version.3.rst

package info (click to toggle)
openmpi 5.0.8-10
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 201,692 kB
  • sloc: ansic: 613,078; makefile: 42,351; sh: 11,194; javascript: 9,244; f90: 7,052; java: 6,404; perl: 5,179; python: 1,859; lex: 740; fortran: 61; cpp: 20; tcl: 12
file content (72 lines) | stat: -rw-r--r-- 1,555 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
.. _mpi_get_version:

MPI_Get_version
===============

.. include_body

:ref:`MPI_Get_version` |mdash| Returns the version of the standard corresponding
to the current implementation.

SYNTAX
------

C Syntax
^^^^^^^^

.. code-block:: c

   #include <mpi.h>

   int MPI_Get_version(int *version, int *subversion)

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

.. code-block:: fortran

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

   MPI_GET_VERSION(VERSION, SUBVERSION, IERROR)
       INTEGER VERSION, SUBVERSION, IERROR

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

.. code-block:: fortran

   USE mpi_f08

   MPI_Get_version(version, subversion, ierror)
       INTEGER, INTENT(OUT) :: version, subversion
       INTEGER, OPTIONAL, INTENT(OUT) :: ierror

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

* ``version`` : The major version number of the corresponding standard
  (integer).
* ``subversion`` : The minor version number of the corresponding
  standard (integer).
* ``ierror`` : Fortran only: Error status (integer).

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

Since Open MPI |ompi_ver| is MPI-|mpi_standard_version| compliant (see
:ref:`this page for more details about Open MPI standards conformance
<release-notes-mpi-standard-conformance-label>`) this function will return a
``version`` value of |mpi_standard_major_version| and a ``subversion``
value of |mpi_standard_minor_version| for this release.

NOTE
----

:ref:`MPI_Get_version` is one of the few functions that can be called
before :ref:`MPI_Init` and after :ref:`MPI_Finalize`.

ERRORS
------

.. include:: ./ERRORS.rst