Skip to content

Commit 6f2a5b9

Browse files
authored
Merge pull request #8162 from Colton-K/pr/MPI_C_batch2
Converted batch 2 of MPI_C* (MPI_Comm_accept - MPI_Comm_dup_with_info)
2 parents fe03602 + ee3bd58 commit 6f2a5b9

25 files changed

+1035
-1054
lines changed

ompi/mpi/man/man3/MPI_Comm_accept.3in

Lines changed: 0 additions & 85 deletions
This file was deleted.

ompi/mpi/man/man3/MPI_Comm_accept.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Name
2+
3+
`MPI_Comm_accept` - Establishes communication with a client.
4+
5+
# Syntax
6+
7+
## C Syntax
8+
9+
```c
10+
#include <mpi.h>
11+
12+
int MPI_Comm_accept(const char *port_name, MPI_Info info, int root, MPI_Comm comm, MPI_Comm *newcomm)
13+
```
14+
15+
## Fortran Syntax
16+
17+
```fortran
18+
USE MPI
19+
! or the older form: INCLUDE 'mpif.h'
20+
21+
MPI_COMM_ACCEPT(PORT_NAME, INFO, ROOT, COMM, NEWCOMM, IERROR)
22+
CHARACTER*(*) PORT_NAME
23+
INTEGER INFO, ROOT, COMM, NEWCOMM, IERROR
24+
```
25+
26+
## Fortran 2008 Syntax
27+
28+
```fortran
29+
USE mpi_f08
30+
31+
MPI_Comm_accept(port_name, info, root, comm, newcomm, ierror)
32+
CHARACTER(LEN=*), INTENT(IN) :: port_name
33+
TYPE(MPI_Info), INTENT(IN) :: info
34+
INTEGER, INTENT(IN) :: root
35+
TYPE(MPI_Comm), INTENT(IN) :: comm
36+
TYPE(MPI_Comm), INTENT(OUT) :: newcomm
37+
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
38+
```
39+
40+
41+
# Input Parameters
42+
43+
* `port_name` : Port name (string, used only on *root*).
44+
* `info` : Options given by root for the accept (handle, used only on root). No
45+
options currently supported.
46+
* `root` : Rank in *comm* of root node (integer).
47+
* `comm` : Intracommunicator over which call is collective (handle).
48+
49+
# Output Parameters
50+
51+
* `newcomm` : Intercommunicator with client as remote group (handle)
52+
* `IERROR` : Fortran only: Error status (integer).
53+
54+
# Description
55+
56+
`MPI_Comm_accept` establishes communication with a client. It is
57+
collective over the calling communicator. It returns an
58+
intercommunicator that allows communication with the client, after the
59+
client has connected with the `MPI_Comm_accept` function using the
60+
`MPI_Comm_connect` function.
61+
The `port_name` must have been established through a call to
62+
`MPI_Open_port` on the `root`.
63+
64+
# Errors
65+
66+
Almost all MPI routines return an error value; C routines as the value
67+
of the function and Fortran routines in the last argument.
68+
Before the error value is returned, the current MPI error handler is
69+
called. By default, this error handler aborts the MPI job, except for
70+
I/O function errors. The error handler may be changed with
71+
`MPI_Comm_set_errhandler`; the predefined error handler `MPI_ERRORS_RETURN`
72+
may be used to cause error values to be returned.
73+
See the MPI man page for a full list of MPI error codes.
74+
75+
# See Also
76+
77+
[`MPI_Comm_connect`(3)](MPI_Comm_connect.html)
78+
[`MPI_Open_port`(3)](MPI_Open_port.html)

ompi/mpi/man/man3/MPI_Comm_call_errhandler.3in

Lines changed: 0 additions & 81 deletions
This file was deleted.
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Name
2+
3+
`MPI_Comm_call_errhandler` - Passes the supplied error code to the
4+
error handler assigned to a communicator
5+
6+
# Syntax
7+
8+
## C Syntax
9+
10+
```c
11+
#include <mpi.h>
12+
13+
int MPI_Comm_call_errhandler(MPI_Comm comm, int errorcode)
14+
```
15+
16+
## Fortran Syntax
17+
18+
```fortran
19+
USE MPI
20+
! or the older form: INCLUDE 'mpif.h'
21+
22+
MPI_COMM_CALL_ERRHANDLER(COMM, ERRORCODE, IERROR)
23+
INTEGER COMM, ERRORCODE, IERROR
24+
```
25+
26+
## Fortran 2008 Syntax
27+
28+
```fortran
29+
USE mpi_f08
30+
31+
MPI_Comm_call_errhandler(comm, errorcode, ierror)
32+
TYPE(MPI_Comm), INTENT(IN) :: comm
33+
INTEGER, INTENT(IN) :: errorcode
34+
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
35+
```
36+
37+
38+
# Input Parameter
39+
40+
* `comm` : communicator with error handler (handle).
41+
* `errorcode` : error code (integer).
42+
43+
# Output Parameters
44+
45+
* `IERROR` : Fortran only: Error status (integer).
46+
47+
# Description
48+
49+
This function invokes the error handler assigned to the `comm`unicator
50+
`comm` with the supplied error code `errorcode`. If the error handler
51+
was successfully called, the process is not aborted, and the error
52+
handler returns, this function returns `MPI_SUCCESS.`
53+
54+
# Notes
55+
56+
Users should note that the default error handler is
57+
`MPI_ERRORS_ARE_FATAL`. Thus, calling this function will abort the
58+
processes in `comm` if the default error handler has not been changed.
59+
60+
# Errors
61+
62+
Almost all MPI routines return an error value; C routines as the value
63+
of the function and Fortran routines in the last argument.
64+
See the MPI man page for a full list of MPI error codes.
65+
66+
# See Also
67+
68+
[`MPI_Comm_create_errhandler`(3)](MPI_Comm_create_errhandler.html)
69+
[`MPI_Comm_set_errhandler`(3)](MPI_Comm_set_errhandler.html)

ompi/mpi/man/man3/MPI_Comm_compare.3in

Lines changed: 0 additions & 65 deletions
This file was deleted.

0 commit comments

Comments
 (0)