Home Man
Search
Today's Posts
Register

Linux & Unix Commands - Search Man Pages

RedHat 9 (Linux i386) - man page for mpi_init_thread (redhat section 3)

MPI_Init_thread(3)			     LAM/MPI			       MPI_Init_thread(3)

NAME
       MPI_Init_thread -  Initialize the MPI execution environment

SYNOPSIS
       #include <mpi.h>
       int
       MPI_Init_thread(int *pargc, char ***pargv, int requested, int *pprovided)

INPUT PARAMETERS
       pargc  - Pointer to the number of arguments
       pargv  - Pointer to the argument vector
       requested
	      - Desired level of thread support
       pprovided
	      - Given level of thread support

NOTES
       This function is mainly here for link-compatability.  It will [currently] only ever return
       MPI_THREAD_SINGLE in pprovided
	.  Future versions of LAM/MPI will support multi-threaded user programs,  in  which  case
       this  function  must  be used to initialize MPI.  Hence, programmers can use this function
       now in order to program for future flexibility.

       For the moment, however, see MPI_Init (3).

ERRORS
       If an error occurs in an MPI function, the current MPI error handler is called  to  handle
       it.   By default, this error handler aborts the MPI job.  The error handler may be changed
       with MPI_Errhandler_set ; the predefined error handler MPI_ERRORS_RETURN may  be  used  to
       cause  error values to be returned (in C and Fortran; this error handler is less useful in
       with the C++ MPI bindings.   The  predefined  error  handler  MPI::ERRORS_THROW_EXCEPTIONS
       should  be  used in C++ if the error value needs to be recovered).  Note that MPI does not
       guarantee that an MPI program can continue past an error.

       All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error value;  C  routines  as
       the value of the function and Fortran routines in the last argument.  The C++ bindings for
       MPI do not return error values; instead, error values are communicated by throwing  excep-
       tions  of  type	MPI::Exception	(but  not by default).	Exceptions are only thrown if the
       error value is not MPI::SUCCESS
	.

       Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI functions will return
       upon an error, there will be no way to recover what the actual error value was.
       MPI_SUCCESS
	      - No error; MPI routine completed successfully.
       MPI_ERR_ARG
	      -  Invalid  argument.  Some argument is invalid and is not identified by a specific
	      error class.  This is typically a NULL pointer or other such error.
       MPI_ERR_OTHER
	      - This error class is associated with an error code that indicates that an  attempt
	      was  made  to  call  MPI_INIT a second time.  MPI_INIT may only be called once in a
	      program.
       MPI_ERR_OTHER
	      - Other error; use MPI_Error_string to get more information about this error code.

SEE ALSO
       MPI_Init, MPI_Finalize, lamboot, mpirun, lamhalt

MORE INFORMATION
       For more information, please see the official MPI Forum web site, which contains the  text
       of both the MPI-1 and MPI-2 standards.  These documents contain detailed information about
       each MPI function (most of which is not duplicated in these man pages).

       http://www.mpi-forum.org/

ACKNOWLEDGEMENTS
       The LAM Team would like the thank the MPICH Team for the handy  program	to  generate  man
       pages  ("doctext"  from ftp://ftp.mcs.anl.gov/pub/sowing/sowing.tar.gz ), the initial for-
       matting, and some initial text for most of the MPI-1 man pages.

LOCATION
       initthr.c

LAM/MPI 6.5.8				    11/10/2002			       MPI_Init_thread(3)


All times are GMT -4. The time now is 12:48 PM.

Unix & Linux Forums Content Copyrightę1993-2018. All Rights Reserved.
UNIX.COM Login
Username:
Password:  
Show Password