Last modified: 2 May 2013
Name: H5Pget_fapl_mpiposix
Signature:
herr_t H5Pget_fapl_mpiposix( hid_t fapl_id, MPI_Comm *comm, hbool_t *use_gpfs_hints )

Purpose:
Returns MPI communicator information.

Function Removed:
The C functions H5Pset_fapl_mpiposix and H5Pset_fapl_mpiposix and the corresponding Fortran subroutines have been removed from the HDF5 Library at Release 1.8.13. They remain available in earlier releases, through HDF5 Release 1.8.12.

All applications used with HDF5 Release 1.8.13 or later and that use MPI I/O should use the functions H5Pset_fapl_mpio and H5Pget_fapl_mpio or the corresponding Fortran subroutines.

While HDF5’s MPI-POSIX driver (H5Pset_fapl_mpiposix and H5Pget_fapl_mpiposix) once provided performance benefits on some systems, that is no longer the case. HDF5’s MPIO driver (H5Pset_fapl_mpio and H5Pget_fapl_mpio) now provides as good or better performance on all modern systems.

Description:
If the file access property list is set to the H5FD_MPIPOSIX driver, H5Pget_fapl_mpiposix returns the MPI communicator through the comm pointer, if those values are non-null.

comm is not copied, so it is valid only until the file access property list is either modified or closed.

use_gpfs_hints specifies whether to attempt to use GPFS hints when accessing this file. A value of TRUE (or 1) indicates that the hints are being used, where possible. A value of FALSE (or 0) indicates that the hints are not being used.

Parameters:
hid_t fapl_id IN: File access property list identifier.
MPI_Comm *comm OUT: MPI-2 communicator.
hbool_t *use_gpfs_hints     OUT: Use of GPFS hints.

Returns:
Returns a non-negative value if successful. Otherwise returns a negative value.

Fortran90 Interface: h5pget_fapl_mpiposix_f
SUBROUTINE h5pget_fapl_mpiposix_f(prp_id, comm, use_gpfs, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
  INTEGER, INTENT(OUT) :: comm          ! Buffer to return communicator
  LOGICAL, INTENT(OUT) :: use_gpfs
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
END SUBROUTINE h5pget_fapl_mpiposix_f
	

History:
Release     Change
1.8.13 C function and Fortran subroutine removed from HDF5 at this release.
1.6.1 Fortran subroutine introduced.
1.6.0 use_gpfs_hints parameter added.
1.6.0 C function introduced in this release.