MPI_STATUS_F2F08(3)

πŸ“¦
version 5.0.10 Β· 4 versions
, in ubuntu stonking

πŸ’– MPI_STATUS_F2F08(3) πŸ’–

okay bestie, welcome to Open MPI's little status-translator corner of the manual. This is MPI_Status_f082f and MPI_Status_c2f08 (and friends), and they do exactly what the name says: they translate a Fortran 2008 status into a Fortran INTEGER-style status, or vice versa. no cap.


🌸 SYNTAX 🌸

✨ C Syntax

#include <mpi.h>

int MPI_Status_f082f(const MPI_F08_status *f08_status, MPI_Fint *f_status)
int MPI_Status_f2f08(const MPI_Fint *f_status, MPI_F08_status *f08_status)

✨ Fortran mpi Module Syntax

USE MPI

MPI_STATUS_F082F(F08_STATUS, F_STATUS, IERROR)
    TYPE(MPI_Status) :: F08_STATUS
    INTEGER :: STATUS(MPI_STATUS_SIZE), IERROR

MPI_STATUS_F2F08(F_STATUS, F08_STATUS, IERROR)
    INTEGER :: F_STATUS(MPI_STATUS_SIZE), IERROR
    TYPE(MPI_Status) :: F08_STATUS

✨ Fortran mpi_f08 Module Syntax

USE mpi_f08

MPI_Status_f082f(f08_status, f_status, ierror)
    TYPE(MPI_Status), INTENT(IN) :: f08_status
    INTEGER, INTENT(OUT) :: f_status(MPI_STATUS_SIZE)
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

MPI_Status_f2f08(f_status, f08_status, ierror)
    INTEGER, INTENT(IN) :: f_status(MPI_STATUS_SIZE)
    TYPE(MPI_Status), INTENT(OUT) :: f08_status
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

πŸŽ€ PARAMETERS πŸŽ€

  • f08_status β€” the mpi_f08-style MPI status object, living its best derived-datatype life πŸ¦‹
  • f_status β€” the mpi-style INTEGER MPI status object, an array of ints, iconic πŸ’…

🫢 DESCRIPTION 🫢

so these two procedures exist purely to convert back and forth: from a Fortran 2008 status (which is a derived datatype made of integers) to a Fortran status (which is an array of integers), and vice versa. and the way that it converts all the info in the status β€” including the stuff that's hidden β€” is literally the whole point. that's right, no status information is lost in the conversion. periodt.

When you're using MPI_Status_f082f, here's the vibe check:

  • if f08_status is a valid Fortran status, but not the Fortran value of MPI_F08_STATUS_IGNORE (in C), MPI_STATUS_IGNORE (in Fortran), MPI_F08_STATUSES_IGNORE (in C) or MPI_STATUSES_IGNORE (in Fortran), then MPI_Status_f082f returns in f_status a valid array with the same content πŸ’–
  • but if f08_status is the C value of MPI_F08_STATUS_IGNORE or MPI_F08_STATUSES_IGNORE, or the Fortran value of MPI_STATUS_IGNORE or MPI_STATUSES_IGNORE, or if f08_status isn't a valid Fortran status at all, then the call is erroneous. πŸ’€ yeah. don't do that.

When you're using MPI_Status_f2f08, the opposite conversion gets applied. If f_status is MPI_STATUS_IGNORE or MPI_STATUSES_IGNORE, or if f_status isn't a valid Fortran status, then the call is erroneous. same energy, opposite direction πŸ™ˆ

And listen β€” the input status has the same source, tag and error code values as the output status, and it returns the same answers when you query it for count, elements, and cancellation. slay. Also, the conversion function may be called with an input status argument that has an undefined error field, in which case the value of the error field in the output status argument is undefined. (yes, undefined. that's on purpose. don't be shocked when it's undefined.) 😭


πŸ‘‘ NOTES πŸ‘‘

The Fortran subroutines for these MPI routines are only available in the mpi and mpi_f08 modules (including the type specification for TYPE(MPI_Status)). they are (intentionally) not available in mpif.h. intentional. deliberate. by design. iykyk πŸ”₯

See also:

  • MPI_Status_c2f
  • MPI_Status_c2f08

2003-2026, The Open MPI Community


and that's the whole page, bestie πŸ’œ this was Open MPI, dated Sep 10, 2026, filed under MPI_STATUS_F2F08(3) β€” go forth and convert your statuses with zero data loss, you absolute legend β­πŸŽ€βœ¨

πŸ“¦ where this page comes from