mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-01-24 15:25:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix docs for H5Pset_dxpl_mpio_collective_opt() (#3594)

Browse Source
This commit is contained in:
jhendersonHDF 2023-09-25 15:37:15 -05:00 committed by GitHub
parent 1e852b94bd
commit 08b574d68b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/H5FDmpio.c
View File

@ -559,13 +559,13 @@ done:
/*-------------------------------------------------------------------------
* Function: H5Pset_dxpl_mpio_collective_opt
*
* Purpose: To set a flag to choose linked chunk I/O or multi-chunk I/O
* without involving decision-making inside HDF5
*
* Note: The library will do linked chunk I/O or multi-chunk I/O without
* involving communications for decision-making process.
* The library won't behave as it asks for only when we find
* that the low-level MPI-IO package doesn't support this.
* Purpose: Set the data transfer property list DXPL_ID to use transfer
* mode OPT_MODE during I/O. This allows the application to
* specify collective I/O at the HDF5 interface level (with
* the H5Pset_dxpl_mpio routine), while controlling whether
* the actual I/O is performed collectively (e.g., via
* MPI_File_write_at_all) or independently (e.g., via
* MPI_File_write_at).
*
* Return: Success: Non-negative
* Failure: Negative
@ -2032,7 +2032,7 @@ done:
/*-------------------------------------------------------------------------
* Function: H5FD__mpio_read_vector()
*
* Purpose: The behaviour of this function dependes on the value of
* Purpose: The behavior of this function depends on the value of
* the io_xfer_mode obtained from the context.
*
* If it is H5FD_MPIO_COLLECTIVE, this is a collective

18
src/H5FDmpio.h
View File

@ -164,18 +164,24 @@ H5_DLL herr_t H5Pget_dxpl_mpio(hid_t dxpl_id, H5FD_mpio_xfer_t *xfer_mode /*out*
/**
* \ingroup DXPL
*
* \brief Sets data transfer mode
* \brief Sets low-level data transfer mode
*
* \dxpl_id
* \param[in] opt_mode Transfer mode
* \returns \herr_t
*
* \details H5Pset_dxpl_mpio() sets the data transfer property list \p dxpl_id
* to use transfer mode xfer_mode. The property list can then be used
* to control the I/O transfer mode during data I/O operations.
* \details H5Pset_dxpl_mpio_collective_opt() sets the data transfer property
* list \p dxpl_id to use transfer mode \p opt_mode when performing
* I/O. This allows the application to specify collective I/O at the
* HDF5 interface level (with the H5Pset_dxpl_mpio() API routine),
* while controlling whether the actual I/O is performed collectively
* (e.g., via MPI_File_write_at_all) or independently (e.g., via
* MPI_File_write_at). If the collectivity setting at the HDF5
* interface level (set via H5Pset_dxpl_mpio()) is not set to
* H5FD_MPIO_COLLECTIVE, this setting will be ignored.
*
* Valid transfer modes are #H5FD_MPIO_INDEPENDENT (default) and
* #H5FD_MPIO_COLLECTIVE.
* Valid transfer modes are #H5FD_MPIO_COLLECTIVE_IO (default) and
* #H5FD_MPIO_INDIVIDUAL_IO.
*
* \since 1.4.0
*