manpagez: man pages & more
man MPI_Win_flush(3)
Home | html | info | man
MPI_Win_flush(3)                      MPI                     MPI_Win_flush(3)




NAME

       MPI_Win_flush  -   Complete all outstanding RMA operations at the given
       target


SYNOPSIS

       int MPI_Win_flush(int rank, MPI_Win win)


INPUT PARAMETERS

       rank   - rank of target window (non-negative integer)
       win    - window object (handle)



THREAD AND INTERRUPT SAFETY

       This routine is thread-safe.  This  means  that  this  routine  may  be
       safely  used by multiple threads without the need for any user-provided
       thread locks.  However, the routine is not interrupt safe.   Typically,
       this  is due to the use of memory allocation routines such as malloc or
       other non-MPICH runtime routines that  are  themselves  not  interrupt-
       safe.



NOTES FOR FORTRAN

       All  MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
       an additional argument ierr at the end of the argument list.   ierr  is
       an  integer and has the same meaning as the return value of the routine
       in C.  In Fortran, MPI routines are subroutines, and are  invoked  with
       the call statement.

       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
       Fortran.



ERRORS

       All MPI routines (except MPI_Wtime and  MPI_Wtick  )  return  an  error
       value;  C routines as the value of the function and Fortran routines in
       the last argument.  Before the value is returned, the current MPI error
       handler  is called.  By default, this error handler aborts the MPI job.
       The error handler may be changed with MPI_Comm_set_errhandler (for com-
       municators),      MPI_File_set_errhandler      (for     files),     and
       MPI_Win_set_errhandler  (for   RMA   windows).    The   MPI-1   routine
       MPI_Errhandler_set  may  be used but its use is deprecated.  The prede-
       fined error handler MPI_ERRORS_RETURN may be used to cause error values
       to  be  returned.  Note that MPI does not guarantee that an MPI program
       can continue past an error; however, MPI implementations  will  attempt
       to continue whenever possible.

       MPI_SUCCESS
              - No error; MPI routine completed successfully.

       MPI_ERR_RANK
              -  Invalid  source  or  destination rank.  Ranks must be between
              zero and the size of the communicator  minus  one;  ranks  in  a
              receive  (  MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also
              be MPI_ANY_SOURCE .

       MPI_ERR_WIN
              - Invalid MPI window object
       MPI_ERR_OTHER
              - Other error; use  MPI_Error_string  to  get  more  information
              about this error code.



SEE ALSO

       MPI_Win_flush_all(3), MPI_Win_flush_local(3),
       MPI_Win_flush_local_all(3), MPI_Win_lock MPI_Win_lock_all(3)



                                   2/22/2022                  MPI_Win_flush(3)

mpi 4.0.1 - Generated Sun Mar 27 16:16:30 CDT 2022
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.