MPI_Comm_disconnect(3)

1MPI_Comm_disconnect(3)              LAM/MPI             MPI_Comm_disconnect(3)
2
3
4

NAME

6       MPI_Comm_disconnect -  Disconnect a client and server
7

SYNOPSIS

9       #include <mpi.h>
10       int
11       MPI_Comm_disconnect(MPI_Comm *comm)
12

INPUT PARAMETER

14       comm   - communicator
15
16

NOTES FOR FORTRAN

18       All  MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
19       an additional argument ierr at the end of the argument list.   ierr  is
20       an  integer and has the same meaning as the return value of the routine
21       in C.  In Fortran, MPI routines are subroutines, and are  invoked  with
22       the call statement.
23
24       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
25       Fortran.
26
27

USAGE WITH IMPI EXTENSIONS

29       The IMPI standard only supports MPI-1 functions.  Hence, this  function
30       is currently not designed to operate within an IMPI job.
31
32

ERRORS

34       If an error occurs in an MPI function, the current MPI error handler is
35       called to handle it.  By default, this error  handler  aborts  the  MPI
36       job.   The  error  handler may be changed with MPI_Errhandler_set ; the
37       predefined error handler MPI_ERRORS_RETURN may be used to  cause  error
38       values  to  be  returned  (in C and Fortran; this error handler is less
39       useful in with the C++ MPI  bindings.   The  predefined  error  handler
40       MPI::ERRORS_THROW_EXCEPTIONS  should  be used in C++ if the error value
41       needs to be recovered).  Note that MPI does not guarantee that  an  MPI
42       program can continue past an error.
43
44       All  MPI  routines  (except  MPI_Wtime  and MPI_Wtick ) return an error
45       value; C routines as the value of the function and Fortran routines  in
46       the  last  argument.  The C++ bindings for MPI do not return error val‐
47       ues; instead, error values are communicated by throwing  exceptions  of
48       type  MPI::Exception  (but not by default).  Exceptions are only thrown
49       if the error value is not MPI::SUCCESS .
50
51
52       Note that if the MPI::ERRORS_RETURN handler is set in  C++,  while  MPI
53       functions  will  return  upon an error, there will be no way to recover
54       what the actual error value was.
55       MPI_SUCCESS
56              - No error; MPI routine completed successfully.
57       MPI_ERR_OTHER
58              - Other error; use  MPI_Error_string  to  get  more  information
59              about this error code.
60
61

MORE INFORMATION

68       For more information, please see the official MPI Forum web site, which
69       contains  the  text of both the MPI-1 and MPI-2 standards.  These docu‐
70       ments contain detailed information about each  MPI  function  (most  of
71       which is not duplicated in these man pages).
72
73       http://www.mpi-forum.org/
74

LOCATION

76       cdisconnect.c
77
78
79
80LAM/MPI 7.1.2                      2/23/2006            MPI_Comm_disconnect(3)