Home Man
Search
Today's Posts
Register

Linux & Unix Commands - Search Man Pages

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

MPI_Type_get_envelope(3)			       LAM/MPI				     MPI_Type_get_envelope(3)

NAME
MPI_Type_get_envelope - Get datatype envelope contents
SYNOPSIS
#include <mpi.h> int MPI_Type_get_envelope(MPI_Datatype dtype, int *nints, int *naddrs, int *ndtypes, int *combiner)
INPUT PARAMETER
type - Datatype to access
OUTPUT PARAMETERS
nints - Number of elements in ints naddrs - Number of elments in addrs ndtypes - Number of elements in dtypes combiner - Combiner reflecting the MPI datatype constructor call that was used in creating datatype
NOTES FOR FORTRAN
All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the end of the argument list. 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 call statement. All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran.
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_EXCEP- TIONS 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 func- tion and Fortran routines in the last argument. The C++ bindings for MPI do not return error values; instead, error values are communicated by throwing exceptions 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_TYPE - Invalid datatype argument. May be an uncommitted MPI_Datatype (see MPI_Type_commit ).
SEE ALSO
MPI_Type_get_contents(3)
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/
LOCATION
tgetenvl.c
LAM
/MPI 6.5.8 11/10/2002 MPI_Type_get_envelope(3)


All times are GMT -4. The time now is 06:36 PM.

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