Skip to content

Latest commit

 

History

History
91 lines (61 loc) · 2.02 KB

MPI_File_write.3.rst

File metadata and controls

91 lines (61 loc) · 2.02 KB
Raw

MPI_File_write

:ref:`MPI_File_write` - Writes a file starting at the location specified by the individual file pointer (blocking, noncollective).

SYNTAX

C Syntax

#include <mpi.h>

int MPI_File_write(MPI_File fh, const void *buf,
     int count, MPI_Datatype datatype,
     MPI_Status *status)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_WRITE(FH, BUF, COUNT,
     DATATYPE, STATUS, IERROR)
     <type>  BUF(*)
     INTEGER FH, COUNT, DATATYPE, STATUS(MPI_STATUS_SIZE), IERROR

Fortran 2008 Syntax

USE mpi_f08
MPI_File_write(fh, buf, count, datatype, status, ierror)
     TYPE(MPI_File), INTENT(IN) :: fh
     TYPE(*), DIMENSION(..), INTENT(IN) :: buf
     INTEGER, INTENT(IN) :: count
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     TYPE(MPI_Status) :: status
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT/OUTPUT PARAMETER

  • fh: File handle (handle).

INPUT PARAMETERS

  • buf: Initial address of buffer (choice).
  • count: Number of elements in buffer (integer).
  • datatype: Data type of each buffer element (handle).

OUTPUT PARAMETERS

  • status: Status object (status).
  • ierror: Fortran only: Error status (integer).

DESCRIPTION

:ref:`MPI_File_write` attempts to write into the file associated with fh (at the current individual file pointer position maintained by the system) a total number of count data items having datatype type from the user's buffer buf. The data is written into those parts of the file specified by the current view. :ref:`MPI_File_write` stores the number of datatype elements actually written in status. All other fields of status are undefined.

It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was specified when the file was opened.

ERRORS