mpi_query_thread(3openmpi) [osx man page]

MPI_Query_thread(3OpenMPI)												MPI_Query_thread(3OpenMPI)

NAME

       MPI_Query_thread - Returns the current level of thread support

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Query_thread(int *provided)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_QUERY_THREAD(PROVIDED, IERROR)
	    INTEGER   PROVIDED, IERROR

C++ Syntax
       #include <mpi.h>
       int MPI::Query_thread()

OUTPUT PARAMETERS

       provided  C/Fortran only: Level of thread support (integer).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       This  routine  returns  in provided the current level of thread support. If MPI was initialized by a call to MPI_Init_thread, provided will
       have the same value as was returned by that function.

       The possible values of provided are as follows:

       MPI_THREAD_SINGLE       Only one thread may execute.

       MPI_THREAD_FUNNELED     If the process is multithreaded, only the thread that called MPI_Init[_thread] may make MPI calls.

       MPI_THREAD_SERIALIZED   If the process is multithreaded, only one thread may make MPI library calls at one time.

       MPI_THREAD_MULTIPLE     If the process is multithreaded, multiple threads may call MPI at once with no restrictions.

NOTES

       In Open MPI, provided is always MPI_THREAD_SINGLE, unless the program has been linked with the multithreaded library, in  which	case  pro-
       vided is MPI_THREAD_MULTIPLE.

ERRORS

       Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception  mechanism
       will be used to throw an MPI:Exception object.

       Before  the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for
       I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined 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.

       See the MPI man page for a full list of MPI error codes.

SEE ALSO

       MPI_Init
       MPI_Init_thread

Open MPI 1.2							  September 2006					MPI_Query_thread(3OpenMPI)

Check Out this Related Man Page

MPI_Errhandler_get(3OpenMPI)											      MPI_Errhandler_get(3OpenMPI)

NAME

       MPI_Errhandler_get  - Gets the error handler for a communicator -- use of this routine is deprecated.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Errhandler_get(MPI_Comm comm, MPI_Errhandler *errhandler)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_ERRHANDLER_GET(COMM, ERRHANDLER, IERROR)
	    INTEGER   COMM, ERRHANDLER, IERROR

INPUT PARAMETER

       comm	 Communicator to get the error handler from (handle).

OUTPUT PARAMETERS

       errhandler
		 MPI error handler currently associated with communicator (handle).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       Note that use of this routine is deprecated as of MPI-2. Please use MPI_Comm_get_errhandler instead.

       This deprecated routine is not available in C++.

       Returns in errhandler (a handle to) the error handler that is currently associated with communicator comm.

       Example: A library function may register at its entry point the current error handler for a communicator, set its own private error handler
       for this communicator, and restore before exiting the previous error handler.

ERRORS

       Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func-
       tions  do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism
       will be used to throw an MPI:Exception object.

       Before the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except  for
       I/O  function  errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined 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.

SEE ALSO

       MPI_Comm_create_errhandler
       MPI_Comm_get_errhandler
       MPI_Comm_set_errhandler

Open MPI 1.2							  September 2006				      MPI_Errhandler_get(3OpenMPI)

Linux and UNIX Man Pages

mpi_query_thread(3openmpi) [osx man page]

Check Out this Related Man Page