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_Add_error_code(3OpenMPI)											      MPI_Add_error_code(3OpenMPI)

NAME

       MPI_Add_error_code - Creates a new error code associated with errorclass

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Add_error_code(int errorclass, int *errorcode)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_ADD_ERROR_CODE(ERRORCLASS, ERRORCODE, IERROR)
	    INTEGER  ERRORCLASS, ERRORCODE, IERROR

C++ Syntax
       #include <mpi.h>
       int MPI::Add_error_code(int errorclass, int* errorcode)

INPUT PARAMETER

       errorclass    MPI error class (integer).

OUTPUT PARAMETERS

       errorcode     Error code returned by an MPI routine or an MPI error class (integer).

       IERROR	     Fortran only: Error status (integer).

DESCRIPTION

       Creates a new error code associated with errorclass and returns its value in errorcode.

NOTES

       No function is provided to free error codes, as it is not expected that an application will create them in significant numbers.

       The value returned is always greater than or equal to MPI_ERR_LASTCODE.

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_Add_error_class
       MPI_Error_class

Open MPI 1.2							  September 2006				      MPI_Add_error_code(3OpenMPI)

Linux and UNIX Man Pages

mpi_query_thread(3openmpi) [osx man page]

Check Out this Related Man Page