mac mpi

macx64/mpi/mpich/share/man/man3/MPI_Pcontrol.3

@@ -0,0 +1,85 @@
+.TH MPI_Pcontrol 3 "6/5/2019" " " "MPI"
+.SH NAME
+MPI_Pcontrol \-  Controls profiling 
+.SH SYNOPSIS
+.nf
+int MPI_Pcontrol(const int level, ...)
+.fi
+.SH INPUT PARAMETERS
+.PD 0
+.TP
+.B level 
+- Profiling level
+.PD 1
+.PD 0
+.TP
+.B ... 
+- other arguments (see notes)
+.PD 1
+
+.SH NOTES
+This routine provides a common interface for profiling control.  The
+interpretation of 
+.I level
+and any other arguments is left to the
+profiling library.  The intention is that a profiling library will
+provide a replacement for this routine and define the interpretation
+of the parameters.
+
+.SH NOTES FOR FORTRAN
+All MPI routines in Fortran (except for 
+.I MPI_WTIME
+and 
+.I MPI_WTICK
+) have
+an additional argument 
+.I ierr
+at the end of the argument list.  
+.I 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
+.I call
+statement.
+
+All MPI objects (e.g., 
+.I MPI_Datatype
+, 
+.I MPI_Comm
+) are of type 
+.I INTEGER
+in Fortran.
+
+.SH ERRORS
+
+All MPI routines (except 
+.I MPI_Wtime
+and 
+.I 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 
+.I MPI_Comm_set_errhandler
+(for communicators),
+.I MPI_File_set_errhandler
+(for files), and 
+.I MPI_Win_set_errhandler
+(for
+RMA windows).  The MPI-1 routine 
+.I MPI_Errhandler_set
+may be used but
+its use is deprecated.  The predefined error handler
+.I MPI_ERRORS_RETURN
+may be used to cause error values to be returned.
+Note that MPI does 
+.B not
+guarentee that an MPI program can continue past
+an error; however, MPI implementations will attempt to continue whenever
+possible.
+
+.PD 0
+.TP
+.B MPI_SUCCESS 
+- No error; MPI routine completed successfully.
+.PD 1