1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_File_write_ordered 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_File_write_ordered\fP \- Writes a file at a location specified by a shared file pointer (blocking, collective). |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_File_write_ordered(MPI_File \fIfh\fP, void \fI*buf\fP, |
---|
13 | int \fIcount\fP, MPI_Datatype \fIdatatype\fP, |
---|
14 | MPI_Status \fI*status\fP) |
---|
15 | |
---|
16 | Fortran Syntax |
---|
17 | INCLUDE 'mpif.h' |
---|
18 | MPI_FILE_WRITE_ORDERED(\fIFH\fP,\fI BUF\fP,\fI COUNT\fP,\fI DATATYPE\fP, |
---|
19 | \fISTATUS\fP,\fI IERROR\fP) |
---|
20 | <type> \fIBUF\fP(*) |
---|
21 | INTEGER \fIFH, COUNT, DATATYPE, STATUS(MPI_STATUS_SIZE), IERROR\fP |
---|
22 | |
---|
23 | .SH C++ Syntax |
---|
24 | .nf |
---|
25 | #include <mpi.h> |
---|
26 | void MPI::File::Write_ordered(const void* \fIbuf\fP, int \fIcount\fP, |
---|
27 | const MPI::Datatype& \fIdatatype\fP, MPI::Status& \fIstatus\fP) |
---|
28 | |
---|
29 | void MPI::File::Write_ordered(const void* \fIbuf\fP, int \fIcount\fP, |
---|
30 | const MPI::Datatype& \fIdatatype\fP) |
---|
31 | |
---|
32 | .SH INPUT PARAMETERS |
---|
33 | .ft R |
---|
34 | .TP 1i |
---|
35 | fh |
---|
36 | File handle (handle). |
---|
37 | .TP 1i |
---|
38 | buf |
---|
39 | Initial address of buffer (choice). |
---|
40 | .TP 1i |
---|
41 | count |
---|
42 | Number of elements in buffer (integer). |
---|
43 | .TP 1i |
---|
44 | datatype |
---|
45 | Data type of each buffer element (handle). |
---|
46 | |
---|
47 | .SH OUTPUT PARAMETERS |
---|
48 | .ft R |
---|
49 | .TP 1i |
---|
50 | status |
---|
51 | Status object (Status). |
---|
52 | .TP 1i |
---|
53 | IERROR |
---|
54 | Fortran only: Error status (integer). |
---|
55 | |
---|
56 | .SH DESCRIPTION |
---|
57 | .ft R |
---|
58 | MPI_File_write_ordered is a collective routine. This routine must |
---|
59 | be called by all processes in the communicator group associated with |
---|
60 | the file handle |
---|
61 | .I fh. |
---|
62 | Each process may pass different argument values |
---|
63 | for the |
---|
64 | .I datatype |
---|
65 | and |
---|
66 | .I count |
---|
67 | arguments. Each process attempts to |
---|
68 | write, into the file associated with |
---|
69 | .I fh, |
---|
70 | a total number of |
---|
71 | .I count |
---|
72 | data items having datatype type contained in the user's buffer |
---|
73 | .I buf. |
---|
74 | For |
---|
75 | each process, the location in the file at which data is written is the |
---|
76 | position at which the shared file pointer would be after all processes |
---|
77 | whose ranks within the group are less than that of this process had |
---|
78 | written their data. MPI_File_write_ordered returns the number of |
---|
79 | .I datatype |
---|
80 | elements written in |
---|
81 | .I status. |
---|
82 | The shared file pointer is |
---|
83 | updated by the amounts of data requested by all processes of the |
---|
84 | group. |
---|
85 | |
---|
86 | .SH ERRORS |
---|
87 | 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. |
---|
88 | .sp |
---|
89 | Before the error value is returned, the current MPI error handler is |
---|
90 | called. For MPI I/O function errors, the default error handler is set to MPI_ERRORS_RETURN. The error handler may be changed with MPI_File_set_errhandler; the predefined error handler MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI does not guarantee that an MPI program can continue past an error. |
---|
91 | |
---|