H5Part  1.6.6
Functions
File Opening and Closing

Functions

h5part_int64_t H5PartCloseFile (H5PartFile *f)
 
H5PartFile * H5PartOpenFile (const char *filename, const char flags)
 
H5PartFile * H5PartOpenFileAlign (const char *filename, const char flags, h5part_int64_t align)
 
H5PartFile * H5PartOpenFileParallel (const char *filename, const char flags, MPI_Comm comm)
 
H5PartFile * H5PartOpenFileParallelAlign (const char *filename, const char flags, MPI_Comm comm, h5part_int64_t align)
 
h5part_int64_t H5PartSetVerbosityLevel (h5part_int64_t level)
 

Detailed Description

Function Documentation

◆ H5PartCloseFile()

h5part_int64_t H5PartCloseFile ( H5PartFile *  f)

Closes an open file.

Returns
H5PART_SUCCESS or error code
Parameters
[in]f[in] filehandle of the file to close

◆ H5PartOpenFile()

H5PartFile* H5PartOpenFile ( const char *  filename,
const char  flags 
)

Opens file with specified filename.

Flags are bit values that can be combined with the bit operator | and include:

  • H5PART_WRITE - truncate file and open for writing
  • H5PART_APPEND - open file for writing without truncating
  • H5PART_READ - open file read-only

The typical file extension is .h5.

H5PartFile should be treated as an essentially opaque datastructure. It acts as the file handle, but internally it maintains several key state variables associated with the file.

Returns
File handle or NULL
Parameters
[in]filename[in] The name of the data file to open.
[in]flags[in] The access mode for the file.

◆ H5PartOpenFileAlign()

H5PartFile* H5PartOpenFileAlign ( const char *  filename,
const char  flags,
h5part_int64_t  align 
)

Opens file with specified filename, and also specifices an alignment value used for HDF5 tuning parameters.

Flags are bit values that can be combined with the bit operator | and include:

  • H5PART_WRITE - truncate file and open for writing
  • H5PART_APPEND - open file for writing without truncating
  • H5PART_READ - open file read-only

The typical file extension is .h5.

H5PartFile should be treated as an essentially opaque datastructure. It acts as the file handle, but internally it maintains several key state variables associated with the file.

Returns
File handle or NULL
Parameters
[in]filename[in] The name of the data file to open.
[in]flags[in] The access mode for the file.
[in]align[in] Alignment size in bytes.

◆ H5PartOpenFileParallel()

H5PartFile* H5PartOpenFileParallel ( const char *  filename,
const char  flags,
MPI_Comm  comm 
)

Opens file with specified filename.

Flags are bit values that can be combined with the bit operator | and include:

  • H5PART_WRITE - truncate file and open for writing
  • H5PART_APPEND - open file for writing without truncating
  • H5PART_READ - open file read-only
  • H5PART_FS_LUSTRE - enable optimizations for the Lustre file system
  • H5PART_VFD_MPIPOSIX - use the HDF5 MPI-POSIX virtual file driver
  • H5PART_VFD_MPIO_IND - use MPI-IO in indepedent mode

The typical file extension is .h5.

H5PartFile should be treated as an essentially opaque datastructure. It acts as the file handle, but internally it maintains several key state variables associated with the file.

Returns
File handle or NULL
Parameters
[in]filename[in] The name of the data file to open.
[in]flags[in] The access mode for the file.
[in]comm[in] MPI communicator

◆ H5PartOpenFileParallelAlign()

H5PartFile* H5PartOpenFileParallelAlign ( const char *  filename,
const char  flags,
MPI_Comm  comm,
h5part_int64_t  align 
)

Opens file with specified filename, and also specifices an alignment value used for HDF5 tuning parameters.

Flags are bit values that can be combined with the bit operator | and include:

  • H5PART_WRITE - truncate file and open for writing
  • H5PART_APPEND - open file for writing without truncating
  • H5PART_READ - open file read-only
  • H5PART_FS_LUSTRE - enable optimizations for the Lustre file system
  • H5PART_VFD_MPIPOSIX - use the HDF5 MPI-POSIX virtual file driver
  • H5PART_VFD_MPIO_IND - use MPI-IO in indepedent mode

The typical file extension is .h5.

H5PartFile should be treated as an essentially opaque datastructure. It acts as the file handle, but internally it maintains several key state variables associated with the file.

Returns
File handle or NULL
Parameters
[in]filename[in] The name of the data file to open.
[in]flags[in] The access mode for the file.
[in]comm[in] MPI communicator
[in]align[in] Alignment size in bytes.

◆ H5PartSetVerbosityLevel()

h5part_int64_t H5PartSetVerbosityLevel ( h5part_int64_t  level)

Set verbosity level to level.

Returns
H5PART_SUCCESS