1MPI_Group_free(3) LAM/MPI MPI_Group_free(3)
2
6 MPI_Group_free - Frees a group
7
9 #include <mpi.h>
10 int MPI_Group_free(MPI_Group *grp)
11 Input Parameter
12 grp - group (handle)
13
16 On output, grp is set to MPI_GROUP_NULL .
17
21 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
22 an additional argument ierr at the end of the argument list. ierr is
23 an integer and has the same meaning as the return value of the routine
24 in C. In Fortran, MPI routines are subroutines, and are invoked with
25 the call statement.
26 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
28 Fortran.
29
32 If an error occurs in an MPI function, the current MPI error handler is
33 called to handle it. By default, this error handler aborts the MPI
34 job. The error handler may be changed with MPI_Errhandler_set ; the
35 predefined error handler MPI_ERRORS_RETURN may be used to cause error
36 values to be returned (in C and Fortran; this error handler is less
37 useful in with the C++ MPI bindings. The predefined error handler
38 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
39 needs to be recovered). Note that MPI does not guarantee that an MPI
40 program can continue past an error.
41 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
43 value; C routines as the value of the function and Fortran routines in
44 the last argument. The C++ bindings for MPI do not return error val‐
45 ues; instead, error values are communicated by throwing exceptions of
46 type MPI::Exception (but not by default). Exceptions are only thrown
47 if the error value is not MPI::SUCCESS .
48 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
51 functions will return upon an error, there will be no way to recover
52 what the actual error value was.
53 MPI_SUCCESS
54 - No error; MPI routine completed successfully.
55 MPI_ERR_ARG
56 - Invalid argument. Some argument is invalid and is not identi‐
57 fied by a specific error class. This is typically a NULL
58 pointer or other such error.
59 MPI_ERR_ARG
60 - This error class is associated with an error code that indi‐
61 cates that an attempt was made to free one of the permanent
62 groups.
63
66 For more information, please see the official MPI Forum web site, which
67 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
68 ments contain detailed information about each MPI function (most of
69 which is not duplicated in these man pages).
70 http://www.mpi-forum.org/
72
76 The LAM Team would like the thank the MPICH Team for the handy program
77 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
78 ing/sowing.tar.gz ), the initial formatting, and some initial text for
79 most of the MPI-1 man pages.
80
82 gfree.c
83LAM/MPI 7.1.2 2/23/2006 MPI_Group_free(3)