1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Comm_f2c 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Comm_f2c, MPI_Comm_c2f, MPI_File_f2c, MPI_File_c2f, MPI_Info_f2c, MPI_Info_c2f, MPI_Op_f2c, MPI_Op_c2f, MPI_Request_f2c, MPI_Request_c2f, MPI_Type_f2c, MPI_Type_c2f, MPI_Win_f2c, MPI_Win_c2f \fP \- Translates a C handle into a Fortran handle, or vice versa. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | MPI_Comm MPI_Comm_f2c(MPI_Fint \fIcomm\fP) |
---|
13 | MPI_Fint MPI_Comm_c2f(MPI_Comm \fIcomm\fP) |
---|
14 | |
---|
15 | MPI_File MPI_File_f2c(MPI_Fint \fIfile\fP) |
---|
16 | MPI_Fint MPI_File_c2f(MPI_File \fIfile\fP) |
---|
17 | |
---|
18 | MPI_Group MPI_Group_f2c(MPI Fint \fIgroup\fP) |
---|
19 | MPI_Fint MPI_Group_c2f(MPI Group \fIgroup\fP) |
---|
20 | |
---|
21 | MPI_Info MPI_Info_f2c(MPI_Fint \fIinfo\fP) |
---|
22 | MPI_Fint MPI_Info_c2f(MPI_Info \fIinfo\fP) |
---|
23 | |
---|
24 | MPI_Op MPI_Op_f2c(MPI_Fint \fIop\fP) |
---|
25 | MPI_Fint MPI_Op_c2f(MPI_Op \fIop\fP) |
---|
26 | |
---|
27 | MPI_Request MPI_Request_f2c(MPI_Fint \fIrequest\fP) |
---|
28 | MPI_Fint MPI_Request_c2f(MPI_Request \fIrequest\fP) |
---|
29 | |
---|
30 | MPI_Datatype MPI_Type_f2c(MPI_Fint \fIdatatype\fP) |
---|
31 | MPI_Fint MPI_Type_c2f(MPI_Datatype \fIdatatype\fP) |
---|
32 | |
---|
33 | MPI_Win MPI_Win_f2c(MPI_Fint \fIwin\fP) |
---|
34 | MPI_Fint MPI_Win_c2f(MPI_Win \fIwin\fP) |
---|
35 | |
---|
36 | .SH DESCRIPTION |
---|
37 | .ft R |
---|
38 | Handles are passed between Fortran and C or C++ by using an explicit C wrapper to convert Fortran handles to C handles. There is no direct access to C or C++ handles in Fortran. Handles are passed between C and C++ using overloaded C++ operators called from C++ code. There is no direct access to C++ objects from C. The type definition \fIMPI_Fint\fP is provided in C/C++ for an integer of the size that matches a Fortran \fIINTEGER\fP; usually, \fIMPI_Fint\fP will be equivalent to \fIint\fP. The handle translation functions are provided in C to convert from a Fortran handle (which is an integer) to a C handle, and vice versa. |
---|
39 | .PP |
---|
40 | For example, if \fIcomm\fP is a valid Fortran handle to a communicator, then MPI_Comm_f2c returns a valid C handle to that same communicator; if \fIcomm\fP = MPI_COMM_NULL (Fortran value), then MPI_Comm_f2c returns a null C handle; if \fIcomm\fP is an invalid Fortran handle, then MPI_Comm_f2c returns an invalid C handle. |
---|
41 | .SH NOTE |
---|
42 | This function does not return an error value. Consequently, the result of calling it before MPI_Init or after MPI_Finalize is undefined. |
---|