-
Notifications
You must be signed in to change notification settings - Fork 903
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
edgargabriel
merged 2 commits into
open-mpi:main
from
edgargabriel:topic/mpi4.1-status-set-get-funcs
Mar 8, 2025
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.