1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\"Copyright (c) 1996 Thinking Machines |
---|
3 | .TH MPI_Get_address 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Get_address\fP \- Gets the address of a location in memory. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Get_address(void *\fIlocation\fP, MPI_Aint *\fIaddress\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_GET_ADDRESS(\fILOCATION, ADDRESS, IERROR\fP) |
---|
18 | <type> \fILOCATION\fP(*) |
---|
19 | INTEGER \fIADDRESS, IERROR\fP |
---|
20 | |
---|
21 | .SH C++ Syntax |
---|
22 | .nf |
---|
23 | #include <mpi.h> |
---|
24 | MPI::Aint MPI::Get_address(void* \fIlocation\fP) |
---|
25 | |
---|
26 | .SH INPUT PARAMETERS |
---|
27 | .ft R |
---|
28 | .TP 1i |
---|
29 | location |
---|
30 | Location in caller memory (choice). |
---|
31 | |
---|
32 | .SH OUTPUT PARAMETERS |
---|
33 | .ft R |
---|
34 | .TP 1i |
---|
35 | address |
---|
36 | Address of location (integer). |
---|
37 | .TP 1i |
---|
38 | IERROR |
---|
39 | Fortran only: Error status (integer). |
---|
40 | |
---|
41 | .SH DESCRIPTION |
---|
42 | .ft R |
---|
43 | MPI_Get_address returns the byte address of a location in memory. |
---|
44 | .sp |
---|
45 | Example: Using MPI_Get_address for an array. |
---|
46 | .sp |
---|
47 | .nf |
---|
48 | EAL A(100,100) |
---|
49 | .br |
---|
50 | INTEGER I1, I2, DIFF |
---|
51 | .br |
---|
52 | CALL MPI_GET_ADDRESS(A(1,1), I1, IERROR) |
---|
53 | .br |
---|
54 | CALL MPI_GET_ADDRESS(A(10,10), I2, IERROR) |
---|
55 | .br |
---|
56 | DIFF = I2 - I1 |
---|
57 | .br |
---|
58 | ! The value of DIFF is 909*sizeofreal; the values of I1 and I2 are |
---|
59 | .br |
---|
60 | ! implementation dependent. |
---|
61 | .fi |
---|
62 | |
---|
63 | .SH NOTES |
---|
64 | .ft R |
---|
65 | Current Fortran MPI codes will run unmodified and will port to any system. However, they may fail if addresses larger than 2^32 - 1 are used in the program. New codes should be written so that they use the new functions. This provides compatibility with C/C++ and avoids errors on 64-bit architectures. However, such newly written codes may need to be (slightly) rewritten to port to old Fortran 77 environments that do not support KIND declarations. |
---|
66 | |
---|
67 | .SH ERRORS |
---|
68 | Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI:Exception object. |
---|
69 | .sp |
---|
70 | Before the error value is returned, the current MPI error handler is |
---|
71 | called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error. |
---|
72 | |
---|