Upgrade macos

macx64/mpi/openmpi/share/man/man3/MPI_Session_finalize.3

@@ -0,0 +1,177 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "MPI_SESSION_FINALIZE" "3" "Feb 14, 2025" "" "Open MPI"
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.sp
+\fI\%MPI_Session_finalize\fP — releases all MPI state associated with a session
+.SH SYNTAX
+.SS C Syntax
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+#include <mpi.h>
+
+int MPI_Session_finalize(MPI_Session *session)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Fortran Syntax
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+USE MPI
+! or the older form: INCLUDE \(aqmpif.h\(aq
+
+MPI_SESSION_FINALIZE(SESSION, IERROR)
+    INTEGER SESSION, IERROR
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Fortran 2008 Syntax
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+USE mpi_f08
+
+MPI_Session_finalize(session, ierror)
+    TYPE(MPI_Session), INTENT(IN) :: session
+    INTEGER, OPTIONAL, INTENT(OUT) :: ierror
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH INPUT PARAMETERS
+.INDENT 0.0
+.IP \(bu 2
+\fBsession\fP : session to be finalized (handle)
+.UNINDENT
+.SH OUTPUT PARAMETERS
+.INDENT 0.0
+.IP \(bu 2
+\fBierror\fP : Fortran only: Error status (integer).
+.UNINDENT
+.SH DESCRIPTION
+.sp
+\fI\%MPI_Session_finalize\fP releases all MPI state associated with the supplied
+session. Every instantiated session must be finalized using
+\fI\%MPI_Session_finalize\fP\&. The handle session is set to MPI_SESSION_NULL by
+the call.
+.SH NOTES
+.sp
+Before an MPI process invokes \fI\%MPI_Session_finalize\fP, the process must
+perform all MPI calls needed to complete its involvement in MPI
+communications: it must locally complete all MPI operations that it
+initiated and it must execute matching calls needed to complete MPI
+communications initiated by other processes. The call to
+\fI\%MPI_Session_finalize\fP does not free objects created by MPI calls; these
+objects are freed using MPI_XXX_FREE calls. \fI\%MPI_Session_finalize\fP may be
+synchronizing on any or all of the groups associated with communicators,
+windows, or files derived from the session and not disconnected, freed,
+or closed, respectively, before the call to \fI\%MPI_Session_finalize\fP
+procedure. \fI\%MPI_Session_finalize\fP behaves as if all such synchronizations
+occur concurrently. As \fI\%MPI_Comm_free\fP may mark a communicator for freeing
+later, \fI\%MPI_Session_finalize\fP may be synchronizing on the group associated
+with a communicator that is only freed (with MPI_Comm_free) rather than
+disconnected (with MPI_Comm_disconnect).
+.SH ERRORS
+.sp
+Almost all MPI routines return an error value; C routines as the return result
+of the function and Fortran routines in the last argument.
+.sp
+Before the error value is returned, the current MPI error handler associated
+with the communication object (e.g., communicator, window, file) is called.
+If no communication object is associated with the MPI call, then the call is
+considered attached to MPI_COMM_SELF and will call the associated MPI error
+handler. When MPI_COMM_SELF is not initialized (i.e., before
+\fI\%MPI_Init\fP/\fI\%MPI_Init_thread\fP, after \fI\%MPI_Finalize\fP, or when using the Sessions
+Model exclusively) the error raises the initial error handler. The initial
+error handler can be changed by calling \fI\%MPI_Comm_set_errhandler\fP on
+MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI
+argument to mpiexec or info key to \fI\%MPI_Comm_spawn\fP/\fI\%MPI_Comm_spawn_multiple\fP\&.
+If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN
+error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error
+handler is called for all other MPI functions.
+.sp
+Open MPI includes three predefined error handlers that can be used:
+.INDENT 0.0
+.IP \(bu 2
+\fBMPI_ERRORS_ARE_FATAL\fP
+Causes the program to abort all connected MPI processes.
+.IP \(bu 2
+\fBMPI_ERRORS_ABORT\fP
+An error handler that can be invoked on a communicator,
+window, file, or session. When called on a communicator, it
+acts as if \fI\%MPI_Abort\fP was called on that communicator. If
+called on a window or file, acts as if \fI\%MPI_Abort\fP was called
+on a communicator containing the group of processes in the
+corresponding window or file. If called on a session,
+aborts only the local process.
+.IP \(bu 2
+\fBMPI_ERRORS_RETURN\fP
+Returns an error code to the application.
+.UNINDENT
+.sp
+MPI applications can also implement their own error handlers by calling:
+.INDENT 0.0
+.IP \(bu 2
+\fI\%MPI_Comm_create_errhandler\fP then \fI\%MPI_Comm_set_errhandler\fP
+.IP \(bu 2
+\fI\%MPI_File_create_errhandler\fP then \fI\%MPI_File_set_errhandler\fP
+.IP \(bu 2
+\fI\%MPI_Session_create_errhandler\fP then \fI\%MPI_Session_set_errhandler\fP or at \fI\%MPI_Session_init\fP
+.IP \(bu 2
+\fI\%MPI_Win_create_errhandler\fP then \fI\%MPI_Win_set_errhandler\fP
+.UNINDENT
+.sp
+Note that MPI does not guarantee that an MPI program can continue past
+an error.
+.sp
+See the \fI\%MPI man page\fP for a full list of \fI\%MPI error codes\fP\&.
+.sp
+See the Error Handling section of the MPI\-3.1 standard for
+more information.
+.sp
+\fBSEE ALSO:\fP
+.INDENT 0.0
+.INDENT 3.5
+\fI\%MPI_Session_init\fP
+.UNINDENT
+.UNINDENT
+.SH COPYRIGHT
+2003-2025, The Open MPI Community
+.\" Generated by docutils manpage writer.
+.