Skip to content

mpi: add new status_set/get functions #13125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -419,9 +419,15 @@ OMPI_MAN3 = \
MPI_Status_f082f.3 \
MPI_Status_f2c.3 \
MPI_Status_f2f08.3 \
MPI_Status_get_error.3 \
MPI_Status_get_source.3 \
MPI_Status_get_tag.3 \
MPI_Status_set_cancelled.3 \
MPI_Status_set_elements.3 \
MPI_Status_set_elements_x.3 \
MPI_Status_set_error.3 \
MPI_Status_set_source.3 \
MPI_Status_set_tag.3 \
MPI_T.3 \
MPI_T_category_changed.3 \
MPI_T_category_get_categories.3 \
Expand Down
67 changes: 67 additions & 0 deletions docs/man-openmpi/man3/MPI_Status_get_error.3.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
.. _mpi_status_get_error:


MPI_Status_get_error
========================

.. include_body

:ref:`MPI_Status_get_error` |mdash| Retrieves the MPI_ERROR field from *status*.


SYNTAX
------


C Syntax
^^^^^^^^

.. code-block:: c

#include <mpi.h>

int MPI_Status_get_error(MPI_Status *status, int *error)


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

.. code-block:: fortran

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_STATUS_GET_ERROR(STATUS, ERROR, IERROR)
INTEGER STATUS(MPI_STATUS_SIZE), IERROR
INTEGER ERROR


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

.. code-block:: fortran

USE mpi_f08
MPI_Status_get_error(status, error, ierror)
TYPE(MPI_Status), INTENT(IN) :: status
INTEGER, INTENT(OUT) :: error
INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT PARAMETER
---------------
* ``status``: Status from which to retrieve the error (status).

OUTPUT PARAMETER
----------------
* ``error``: error set in the MPI_ERROR field (integer).
* ``ierror``: Fortran only: Error status (integer).

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

Returns in error the MPI_ERROR field from the status object.


ERRORS
------

.. include:: ./ERRORS.rst
68 changes: 68 additions & 0 deletions docs/man-openmpi/man3/MPI_Status_get_source.3.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
.. _mpi_status_get_source:


MPI_Status_get_source
========================

.. include_body

:ref:`MPI_Status_get_source` |mdash| Retrieves the MPI_SOURCE field from *status*.


SYNTAX
------


C Syntax
^^^^^^^^

.. code-block:: c

#include <mpi.h>

int MPI_Status_get_source(MPI_Status *status, int *source)


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

.. code-block:: fortran

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_STATUS_GET_SOURCE(STATUS, SOURCE, IERROR)
INTEGER STATUS(MPI_STATUS_SIZE), IERROR
INTEGER SOURCE


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

.. code-block:: fortran

USE mpi_f08
MPI_Status_get_source(status, source, ierror)
TYPE(MPI_Status), INTENT(IN) :: status
INTEGER, INTENT(OUT) :: source
INTEGER, OPTIONAL, INTENT(OUT) :: ierror


INPUT PARAMETER
---------------
* ``status``: Status from which to retrieve the source rank (status).

OUTPUT PARAMETER
----------------
* ``source``: rank set in the MPI_SOURCE field (integer).
* ``ierror``: Fortran only: Error status (integer).

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

Returns in source the MPI_SOURCE field from the status object.


ERRORS
------

.. include:: ./ERRORS.rst
68 changes: 68 additions & 0 deletions docs/man-openmpi/man3/MPI_Status_get_tag.3.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
.. _mpi_status_get_tag:


MPI_Status_get_tag
========================

.. include_body

:ref:`MPI_Status_get_tag` |mdash| Retrieves the MPI_TAG field from *status*.


SYNTAX
------


C Syntax
^^^^^^^^

.. code-block:: c

#include <mpi.h>

int MPI_Status_get_tag(MPI_Status *status, int *tag)


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

.. code-block:: fortran

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_STATUS_GET_TAG(STATUS, TAG, IERROR)
INTEGER STATUS(MPI_STATUS_SIZE), IERROR
INTEGER TAG


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

.. code-block:: fortran

USE mpi_f08
MPI_Status_get_tag(status, tag, ierror)
TYPE(MPI_Status), INTENT(IN) :: status
INTEGER, INTENT(OUT) :: tag
INTEGER, OPTIONAL, INTENT(OUT) :: ierror


INPUT PARAMETER
---------------
* ``status``: Status from which to retrieve the tag (status).

OUTPUT PARAMETER
----------------
* ``tag``: tag set in the MPI_TAG field (integer).
* ``ierror``: Fortran only: Error status (integer).

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

Returns in tag the MPI_TAG field from the status object.


ERRORS
------

.. include:: ./ERRORS.rst
71 changes: 71 additions & 0 deletions docs/man-openmpi/man3/MPI_Status_set_error.3.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
.. _mpi_status_set_error:


MPI_Status_set_error
========================

.. include_body

:ref:`MPI_Status_set_error` |mdash| Sets the MPI_ERROR field on *status*.


SYNTAX
------


C Syntax
^^^^^^^^

.. code-block:: c

#include <mpi.h>

int MPI_Status_set_error(MPI_Status *status, int error)


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

.. code-block:: fortran

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_STATUS_SET_ERROR(STATUS, ERROR, IERROR)
INTEGER STATUS(MPI_STATUS_SIZE), IERROR
INTEGER ERROR


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

.. code-block:: fortran

USE mpi_f08
MPI_Status_set_error(status, error, ierror)
TYPE(MPI_Status), INTENT(INOUT) :: status
INTEGER, INTENT(IN) :: error
INTEGER, OPTIONAL, INTENT(OUT) :: ierror


INPUT/OUTPUT PARAMETER
----------------------
* ``status``: Status with which to associate error (status).

INPUT PARAMETER
---------------
* ``error``: error to set in the MPI_ERROR field (integer).

OUTPUT PARAMETER
----------------
* ``ierror``: Fortran only: Error status (integer).

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

Set the MPI_ERROR field in the status object to the provided error argument.


ERRORS
------

.. include:: ./ERRORS.rst
71 changes: 71 additions & 0 deletions docs/man-openmpi/man3/MPI_Status_set_source.3.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
.. _mpi_status_set_source:


MPI_Status_set_source
========================

.. include_body

:ref:`MPI_Status_set_source` |mdash| Sets the MPI_SOURCE field on *status*.


SYNTAX
------


C Syntax
^^^^^^^^

.. code-block:: c

#include <mpi.h>

int MPI_Status_set_source(MPI_Status *status, int source)


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

.. code-block:: fortran

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_STATUS_SET_SOURCE(STATUS, SOURCE, IERROR)
INTEGER STATUS(MPI_STATUS_SIZE), IERROR
INTEGER SOURCE


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

.. code-block:: fortran

USE mpi_f08
MPI_Status_set_source(status, source, ierror)
TYPE(MPI_Status), INTENT(INOUT) :: status
INTEGER, INTENT(IN) :: source
INTEGER, OPTIONAL, INTENT(OUT) :: ierror


INPUT/OUTPUT PARAMETER
----------------------
* ``status``: Status with which to associate source rank (status).

INPUT PARAMETER
---------------
* ``source``: rank to set in the MPI_SOURCE field (integer).

OUTPUT PARAMETER
----------------
* ``ierror``: Fortran only: Error status (integer).

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

Set the MPI_SOURCE field in the status object to the provided source argument.


ERRORS
------

.. include:: ./ERRORS.rst
Loading