GEOSX
Public Member Functions | List of all members
geosx::HDFFile Class Reference

#include <TimeHistHDF.hpp>

Inheritance diagram for geosx::HDFFile:
Inheritance graph
[legend]

Public Member Functions

 HDFFile (string const &fnm, bool deleteExisting, bool parallelAccess, MPI_Comm comm)
 Constructor – this creates/opens the target file for read/write. More...
 
 ~HDFFile ()
 
virtual operator hid_t () final
 Get the HDF hid_t file identifier. More...
 
- Public Member Functions inherited from geosx::HDFTarget
virtual bool checkInTarget (const string &name)
 Whether a dataset/group with the specified name exists in the target. More...
 

Detailed Description

A class used to control access to an HDF file target.

Definition at line 68 of file TimeHistHDF.hpp.

Constructor & Destructor Documentation

◆ HDFFile()

geosx::HDFFile::HDFFile ( string const &  fnm,
bool  deleteExisting,
bool  parallelAccess,
MPI_Comm  comm 
)

Constructor – this creates/opens the target file for read/write.

Parameters
fnmThe filename.
deleteExistingWhether to remove/recreate if a file with the same name exists.
parallelAccessWhether to access one file in parallel or one file per rank in the comm.
commAn MPI communicator where each rank in the communicator will be accesing the target file.

◆ ~HDFFile()

geosx::HDFFile::~HDFFile ( )

Destructor – Close the file and acccessors.

Member Function Documentation

◆ operator hid_t()

virtual geosx::HDFFile::operator hid_t ( )
inlinefinalvirtual

Get the HDF hid_t file identifier.

Returns
the HDF hid_t file id.

Reimplemented from geosx::HDFTarget.

Definition at line 89 of file TimeHistHDF.hpp.


The documentation for this class was generated from the following file: