libROM  v1.0
Data-driven physical simulation library
Public Member Functions | List of all members
CAROM::HDFDatabaseMPIO Class Reference

#include <HDFDatabaseMPIO.h>

Inheritance diagram for CAROM::HDFDatabaseMPIO:
CAROM::HDFDatabase CAROM::Database

Public Member Functions

 HDFDatabaseMPIO ()
 Default constructor.
 
virtual ~HDFDatabaseMPIO ()
 Destructor.
 
- Public Member Functions inherited from CAROM::HDFDatabase
 HDFDatabase ()
 Default constructor.
 
virtual ~HDFDatabase ()
 Destructor.
 
virtual bool create (const std::string &file_name, const MPI_Comm comm=MPI_COMM_NULL) override
 Creates a new HDF5 database file with the supplied name. More...
 
virtual bool open (const std::string &file_name, const std::string &type, const MPI_Comm comm=MPI_COMM_NULL) override
 Opens an existing HDF5 database file with the supplied name. More...
 
virtual bool close ()
 Closes the currently open HDF5 database file. More...
 
virtual void putIntegerArray (const std::string &key, const int *const data, int nelements, const bool distributed=false)
 Writes an array of integers associated with the supplied key to the currently open HDF5 database file. More...
 
virtual void putDoubleArray (const std::string &key, const double *const data, int nelements, const bool distributed=false)
 Writes an array of doubles associated with the supplied key to the currently open HDF5 database file. More...
 
virtual void putDoubleVector (const std::string &key, const std::vector< double > &data, int nelements, const bool distributed=false)
 Writes a vector of doubles associated with the supplied key to the currently open HDF5 database file. More...
 
virtual void getIntegerArray (const std::string &key, int *data, int nelements, const bool distributed=false)
 Reads an array of integers associated with the supplied key from the currently open HDF5 database file. More...
 
virtual int getDoubleArraySize (const std::string &key)
 Count the number of elements in an array of doubles associated with the supplied key from the currently open HDF5 database file. More...
 
virtual void getDoubleArray (const std::string &key, double *data, int nelements, const bool distributed=false)
 Reads an array of doubles associated with the supplied key from the currently open HDF5 database file. More...
 
virtual void getDoubleArray (const std::string &key, double *data, int nelements, const std::vector< int > &idx, const bool distributed=false)
 Reads a sub-array of doubles associated with the supplied key from the currently open HDF5 database file. More...
 
virtual void getDoubleArray (const std::string &key, double *data, int nelements, int offset, int block_size, int stride, const bool distributed=false)
 Reads an array of doubles associated with the supplied key from the currently open HDF5 database file. More...
 
- Public Member Functions inherited from CAROM::Database
 Database ()
 Default constructor.
 
virtual ~Database ()
 Destructor.
 
void putInteger (const std::string &key, int data)
 Writes an integer associated with the supplied key to currently open database file. More...
 
void putDouble (const std::string &key, double data)
 Writes a double associated with the supplied key to currently open database file. More...
 
void getInteger (const std::string &key, int &data)
 Reads an integer associated with the supplied key from the currently open database file. More...
 
void getDouble (const std::string &key, double &data)
 Reads a double associated with the supplied key from the currently open database file. More...
 

Additional Inherited Members

- Public Types inherited from CAROM::Database
enum class  formats { HDF5 , CSV , HDF5_MPIO }
 Implemented database file formats. Add to this enum each time a new database format is implemented.
 
- Protected Member Functions inherited from CAROM::HDFDatabase
bool isInteger (const std::string &key)
 Returns true if the specified key represents an integer entry. If the key does not exist or if the string is empty then false is returned. More...
 
bool isDouble (const std::string &key)
 Returns true if the specified key represents a double entry. If the key does not exist or if the string is empty then false is returned. More...
 
virtual void writeAttribute (int type_key, hid_t dataset_id)
 Write an attribute to the specified dataset. More...
 
int readAttribute (hid_t dataset_id)
 Read an attribute from the specified dataset. More...
 
- Protected Attributes inherited from CAROM::HDFDatabase
bool d_is_file
 True if the HDF5 database is mounted to a file.
 
hid_t d_file_id
 ID of file attached to database or -1 if not mounted to a file.
 
hid_t d_group_id
 ID of the group attached to the database.
 
int d_rank
 MPI process rank.
 
- Static Protected Attributes inherited from CAROM::HDFDatabase
static const int KEY_DOUBLE_ARRAY = 0
 The key representing a double array.
 
static const int KEY_INT_ARRAY = 1
 The key representing an integer array.
 

Detailed Description

HDFDatabaseMPIO implements Multi-Path Input/Output (MPIO) of HDF5.

Definition at line 23 of file HDFDatabaseMPIO.h.


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