#include <deal.II/base/hdf5.h>
This class implements an HDF5 File
Definition at line 1074 of file hdf5.h.
◆ FileAccessMode
File access mode
| Enumerator |
|---|
| open | Read/write, file must exist
|
| create | Create file, truncate if exists
|
Definition at line 1080 of file hdf5.h.
◆ GroupAccessMode
Group access mode
| Enumerator |
|---|
| open | Opens an existing group
|
| create | Creates a new group
|
Definition at line 983 of file hdf5.h.
◆ File() [1/3]
| HDF5::File::File |
( |
const std::string & |
name, |
|
|
const FileAccessMode |
mode |
|
) |
| |
Creates or opens an HDF5 file for serial operations. This call does not require MPI support. It creates or opens an HDF5 file depending on the value of mode.
Definition at line 396 of file hdf5.cc.
◆ File() [2/3]
Creates or opens an HDF5 file in parallel using MPI. This requires that deal.II and HDF5 were compiled with MPI support. It creates or opens a HDF5 file depending on the value of mode. mpi_communicator defines the processes that participate in this call; MPI_COMM_WORLD is a common value for the MPI communicator.
Definition at line 410 of file hdf5.cc.
◆ File() [3/3]
Delegation internal constructor. File(const std::string &, const MPI_Comm &, const Mode); and File(const std::string &, const Mode) should be used to open or create HDF5 files.
Definition at line 418 of file hdf5.cc.
◆ open_group()
| Group HDF5::Group::open_group |
( |
const std::string & |
name | ) |
const |
|
inherited |
◆ create_group()
| Group HDF5::Group::create_group |
( |
const std::string & |
name | ) |
const |
|
inherited |
◆ open_dataset()
| DataSet HDF5::Group::open_dataset |
( |
const std::string & |
name | ) |
const |
|
inherited |
Opens a dataset.
Definition at line 389 of file hdf5.cc.
◆ create_dataset()
template<typename number >
| DataSet HDF5::Group::create_dataset |
( |
const std::string & |
name, |
|
|
const std::vector< hsize_t > & |
dimensions |
|
) |
| const |
|
inherited |
Creates a dataset. number can be float, double, std::complex<float>, std::complex<double>, int or unsigned int.
Datatype conversion takes place at the time of a read or write and is automatic. See the Data Transfer: Datatype Conversion and Selection section in the HDF5 User's Guide.
Definition at line 2238 of file hdf5.h.
◆ write_dataset()
template<typename Container >
| void HDF5::Group::write_dataset |
( |
const std::string & |
name, |
|
|
const Container & |
data |
|
) |
| const |
|
inherited |
Create and write data to a dataset. number can be float, double, std::complex<float>, std::complex<double>, int or unsigned int.
Datatype conversion takes place at the time of a read or write and is automatic. See the Data Transfer: Datatype Conversion and Selection section in the HDF5 User's Guide.
Container can be std::vector<float>, std::vector<double>, std::vector<std::complex<float>>, std::vector<std::complex<double>>, std::vector<int>, std::vector<unsigned int>, Vector<float>, Vector<double>, Vector<std::complex<float>>, Vector<std::complex<double>>, FullMatrix<float>, FullMatrix<double>, FullMatrix<std::complex<float>> or FullMatrix<std::complex<double>>.
Definition at line 2249 of file hdf5.h.
◆ get_attribute() [1/2]
template<typename T >
| T HDF5::HDF5Object::get_attribute |
( |
const std::string & |
attr_name | ) |
const |
|
inherited |
Reads an attribute. T can be float, double, std::complex<float>, std::complex<double>, int, unsigned int, bool or std::string. Note that the encoding of std::string is UTF8 in order to be compatible with python3.
Datatype conversion takes place at the time of a read or write and is automatic. See the Data Transfer: Datatype Conversion and Selection section in the HDF5 User's Guide.
Definition at line 1602 of file hdf5.h.
◆ get_attribute() [2/2]
template<>
| std::string HDF5::HDF5Object::get_attribute |
( |
const std::string & |
attr_name | ) |
const |
|
inlineinherited |
◆ set_attribute() [1/2]
template<typename T >
| void HDF5::HDF5Object::set_attribute |
( |
const std::string & |
attr_name, |
|
|
const T |
value |
|
) |
| |
|
inherited |
Writes an attribute. T can be float, double, std::complex<float>, std::complex<double>, int, unsigned int, bool or std::string. Note that the encoding of std::string is UTF8 in order to be compatible with python3.
Datatype conversion takes place at the time of a read or write and is automatic. See the Data Transfer: Datatype Conversion and Selection section in the HDF5 User's Guide.
Definition at line 1679 of file hdf5.h.
◆ set_attribute() [2/2]
template<>
| void HDF5::HDF5Object::set_attribute |
( |
const std::string & |
attr_name, |
|
|
const std::string |
value |
|
) |
| |
|
inlineinherited |
◆ get_name()
| std::string HDF5::HDF5Object::get_name |
( |
| ) |
const |
|
inherited |
Returns the name of the object. In the case of File, name corresponds to the file name. In the case of Group and DataSet, name corresponds to the name of the object in the HDF5 file.
Definition at line 82 of file hdf5.cc.
◆ name
| const std::string HDF5::HDF5Object::name |
|
protectedinherited |
Name of the HDF5Oject. In the case of File, name corresponds to the file name. In the case of Group and DataSet name corresponds to the name of the object in the HDF5 file.
Definition at line 406 of file hdf5.h.
◆ hdf5_reference
| std::shared_ptr<hid_t> HDF5::HDF5Object::hdf5_reference |
|
protectedinherited |
HDF5 identifier for the objects File, Group and DataSet. The std::shared_ptr<> pointer allows the object to be copied. For example several parts of the program can share and access the same group; when all the functions that access the group are closed, the HDF5 resources of the group will be automatically released.
Definition at line 415 of file hdf5.h.
◆ mpi
| const bool HDF5::HDF5Object::mpi |
|
protectedinherited |
If true use parallel HDF5, if false use serial HDF5.
Definition at line 420 of file hdf5.h.
The documentation for this class was generated from the following files:
1.9.5