1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
.TH MPI_Group_free 3 "11/19/2001" "LAM/MPI 6.5.6" "LAM/MPI"
.SH NAME
MPI_Group_free \- Frees a group
.SH SYNOPSIS
.nf
#include <mpi.h>
int MPI_Group_free(MPI_Group *grp)
.fi
Input Parameter
.PD 0
.TP
.B grp
- group (handle)
.PD 1
.SH NOTES
On output,
.I grp
is set to
.I MPI_GROUP_NULL
.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
)
have an additional argument
.I ierr
at the end of the argument list.
.I 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
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH 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
.I MPI_Errhandler_set
;
the predefined error handler
.I 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
.I MPI::ERRORS_THROW_EXCEPTIONS
should be used in C++ if the
error value needs to be recovered). Note that MPI does
.I not
guarantee that an MPI program can continue past an error.
All MPI routines (except
.I MPI_Wtime
and
.I 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 exceptions
of type
.I MPI::Exception
(but not by default). Exceptions are only
thrown if the error value is not
.I MPI::SUCCESS
.
Note that if the
.I 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.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B 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.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- This error class is associated with an error code that
indicates that an attempt was made to free one of the permanent
groups.
.PD 1
.SH 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).
.I http://www.mpi-forum.org/
.SH ACKNOWLEDGEMENTS
The LAM Team would like the thank the MPICH Team for the handy program
to generate man pages ("doctext" from
.I ftp://ftp.mcs.anl.gov/pub/sowing/sowing.tar.gz
), the initial
formatting, and some initial text for most of the MPI-1 man pages.
.SH LOCATION
gfree.c
|
