<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MPI_Init_thread</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<H1 id="MPI_Init_thread">MPI_Init_thread</H1>
Initialize the MPI execution environment
<H2>Synopsis</H2>
<PRE>
int MPI_Init_thread(int *argc, char ***argv, int required, int *provided)
</PRE>
<H2>Input Parameters</H2>
<DL>
<DT><B>argc </B> <DD> Pointer to the number of arguments
<DT><B>argv </B> <DD> Pointer to the argument vector
<DT><B>required </B> <DD> Level of desired thread support
</DL>
<P>
<H2>Output Parameters</H2>
<DL>
<DT><B>provided </B> <DD> Level of provided thread support
</DL>
<P>
<H2>Command line arguments</H2>
MPI specifies no command-line arguments but does allow an MPI
implementation to make use of them. See <tt>MPI_INIT</tt> for a description of
the command line arguments supported by <tt>MPI_INIT</tt> and <tt>MPI_INIT_THREAD</tt>.
<P>
<H2>Notes</H2>
The valid values for the level of thread support are:
<DL>
<DT><B>MPI_THREAD_SINGLE </B> <DD> Only one thread will execute.
<DT><B>MPI_THREAD_FUNNELED </B> <DD> The process may be multi-threaded, but only the main
thread will make MPI calls (all MPI calls are funneled to the
main thread).
<DT><B>MPI_THREAD_SERIALIZED </B> <DD> The process may be multi-threaded, and multiple
threads may make MPI calls, but only one at a time: MPI calls are not
made concurrently from two distinct threads (all MPI calls are serialized).
<DT><B>MPI_THREAD_MULTIPLE </B> <DD> Multiple threads may call MPI, with no restrictions.
</DL>
<P>
<H2>Notes for Fortran</H2>
Note that the Fortran binding for this routine does not have the <tt>argc</tt> and
<tt>argv</tt> arguments. (<tt>MPI_INIT_THREAD(required, provided, ierror)</tt>)
<P>
<P>
<H2>Errors</H2>
<P>
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) 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 <tt>MPI_Comm_set_errhandler</tt> (for communicators),
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
RMA windows). The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
its use is deprecated. The predefined error handler
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
Note that MPI does <em>not</em> guarentee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
<P>
<DL>
<DT><B>MPI_SUCCESS </B> <DD> No error; MPI routine completed successfully.
</DL>
<DL>
<DT><B>MPI_ERR_OTHER </B> <DD> Other error; use <tt>MPI_Error_string</tt> to get more information
about this error code.
</DL>
<P>
<H2>See Also</H2>
MPI_Init, MPI_Finalize
<br>
</BODY></HTML>