summaryrefslogtreecommitdiffstats
path: root/src/H5FDmpio.h
diff options
context:
space:
mode:
authorJordan Henderson <jhenderson@hdfgroup.org>2023-10-03 19:39:01 (GMT)
committerJordan Henderson <jhenderson@hdfgroup.org>2023-10-03 19:39:01 (GMT)
commitdb8b00865fdb76ce076d2032a0b27c5b012e9afc (patch)
tree3ffb877096fe9dec084f9d0d6a43e9a416460f35 /src/H5FDmpio.h
parent3f0b8817a166bac02ee6155544b950d9c4cdfbc3 (diff)
parentcb6de06dcc18b31ab3f1d53bd93f0bbfaa0a17e1 (diff)
downloadhdf5-db8b00865fdb76ce076d2032a0b27c5b012e9afc.zip
hdf5-db8b00865fdb76ce076d2032a0b27c5b012e9afc.tar.gz
hdf5-db8b00865fdb76ce076d2032a0b27c5b012e9afc.tar.bz2
Merge branch 'develop' into feature/vol_tools_tests
Diffstat (limited to 'src/H5FDmpio.h')
-rw-r--r--src/H5FDmpio.h20
1 files changed, 13 insertions, 7 deletions
diff --git a/src/H5FDmpio.h b/src/H5FDmpio.h
index 3678601..96a9366 100644
--- a/src/H5FDmpio.h
+++ b/src/H5FDmpio.h
@@ -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.
- *
- * Valid transfer modes are #H5FD_MPIO_INDEPENDENT (default) and
- * #H5FD_MPIO_COLLECTIVE.
+ * \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_COLLECTIVE_IO (default) and
+ * #H5FD_MPIO_INDIVIDUAL_IO.
*
* \since 1.4.0
*