Unix/Linux Go Back    

RedHat 9 (Linux i386) - man page for mpi_win_free (redhat section 3)

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)

MPI_Win_free(3) 			     LAM/MPI				  MPI_Win_free(3)

       MPI_Win_free -  Frees a window object

       #include <mpi.h>
       MPI_Win_free(MPI_Win *win)

       win    - window object (handle)

       Frees  the  window object win and returns a null handle (equal to MPI_WIN_NULL). This is a
       collective  call  executed  by  all  processes  in  the	 group	 associated   with   win.
       MPI_WIN_FREE(win)  can be invoked by a process only after it has completed its involvement
       in RMA communications on window win: i.e., the process has called MPI_WIN_FENCE, or called
       MPI_WIN_WAIT  to match a previous call to MPI_WIN_POST or called MPI_WIN_COMPLETE to match
       a previous call to MPI_WIN_START or called MPI_WIN_UNLOCK to  match  a  previous  call  to
       MPI_WIN_LOCK. When the call returns, the window memory can be freed.

       All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argu-
       ment 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.

       The IMPI standard only supports MPI-1 functions.  Hence, this function  is  currently  not
       designed to operate within an IMPI job.

       If  an  error occurs in an MPI function, the current MPI error handler is called to handle
       it.  By default, this error handler aborts the MPI job.	The error handler may be  changed
       with  MPI_Errhandler_set  ;  the predefined error handler MPI_ERRORS_RETURN may be used to
       cause error values to be returned (in C and Fortran; this error handler is less useful  in
       with  the  C++  MPI  bindings.	The predefined error handler MPI::ERRORS_THROW_EXCEPTIONS
       should be used in C++ if the error value needs to be recovered).  Note that MPI	does  not
       guarantee that an MPI program can continue past an error.

       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.  The C++ bindings for
       MPI  do not return error values; instead, error values are communicated by throwing excep-
       tions of type MPI::Exception (but not by default).  Exceptions  are  only  thrown  if  the
       error value is not MPI::SUCCESS

       Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI functions will return
       upon an error, there will be no way to recover what the actual error value was.
	      - No error; MPI routine completed successfully.
	      - Invalid window.  A common error is to use a null window in a call.
	      - This error indicates than an operation has been attempted on a	"closed"  window.
	      Certain  one-sided operations can only be performed on windows whose epoch has been
	      started with MPI_Win_start.

       MPI_Put(3),   MPI_Get(3),   MPI_Win_create(3),	MPI_Win_start(3),    MPI_Win_complete(3),
       MPI_Win_fence(3),     MPI_Accumulate(3),    MPI_Win_get_group(3),    MPI_Win_get_group(3),

       For more information, please see the official MPI Forum web site, which contains the  text
       of both the MPI-1 and MPI-2 standards.  These documents contain detailed information about
       each MPI function (most of which is not duplicated in these man pages).



LAM/MPI 6.5.8				    11/10/2002				  MPI_Win_free(3)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums

All times are GMT -4. The time now is 12:55 PM.