ProcessLib::OutputXDMFHDF5Format Struct Reference

Detailed Description

Definition at line 91 of file OutputFormat.h.

#include <OutputFormat.h>

Inheritance diagram for ProcessLib::OutputXDMFHDF5Format:

Collaboration diagram for ProcessLib::OutputXDMFHDF5Format:

Public Member Functions
	OutputXDMFHDF5Format (std::string const &directory, std::string prefix, std::string suffix, bool const compression, unsigned int const n_files, unsigned int const chunk_size_bytes, bool const store_static_data_separately, std::set< std::string > static_variables)
void	outputMeshes (const int timestep, const double t, const int iteration, bool const converged, std::vector< std::reference_wrapper< const MeshLib::Mesh > > const &meshes, std::set< std::string > const &output_variables) const override
std::string	constructFilename (std::string const &mesh_name, int const timestep, double const t, int const iteration, bool const converged) const override
void	outputMeshXdmf (std::set< std::string > const &output_variables, std::vector< std::reference_wrapper< const MeshLib::Mesh > > const &meshes, int const timestep, double const t, int const iteration, bool const converged) const
Public Member Functions inherited from ProcessLib::OutputFormat
	OutputFormat (std::string const &directory, std::string prefix, std::string suffix, bool const compression)
virtual	~OutputFormat ()=default
	OutputFormat (OutputFormat const &other)=delete
	OutputFormat (OutputFormat &&other)=default
OutputFormat &	operator= (OutputFormat &other)=delete
OutputFormat &	operator= (OutputFormat &&other)=default

Public Attributes
std::unique_ptr< MeshLib::IO::XdmfHdfWriter >	mesh_xdmf_hdf_writer
std::set< std::string > const	static_variables
unsigned int	n_files
	Specifies the number of hdf5 output files.
unsigned int const	chunk_size_bytes
	Specifies the chunks size in bytes per hdf5 output file.
bool const	store_static_data_separately
	split static and dynamic data output to separate files
Public Attributes inherited from ProcessLib::OutputFormat
std::string	directory
std::string	prefix
std::string	suffix
bool	compression
	Enables or disables zlib-compression of the output files.

Constructor & Destructor Documentation

OutputXDMFHDF5Format()

ProcessLib::OutputXDMFHDF5Format::OutputXDMFHDF5Format ( std::string const & directory, std::string prefix, std::string suffix, bool const compression, unsigned int const n_files, unsigned int const chunk_size_bytes, bool const store_static_data_separately, std::set< std::string > static_variables )

inline

Definition at line 93 of file OutputFormat.h.

        : OutputFormat(directory, std::move(prefix), std::move(suffix),
                       compression),
          static_variables(std::move(static_variables)),
          n_files(n_files),
          chunk_size_bytes(chunk_size_bytes),
          store_static_data_separately(store_static_data_separately)
    {
    }

References ProcessLib::OutputFormat::OutputFormat(), chunk_size_bytes, ProcessLib::OutputFormat::compression, ProcessLib::OutputFormat::directory, n_files, ProcessLib::OutputFormat::prefix, static_variables, store_static_data_separately, and ProcessLib::OutputFormat::suffix.

Member Function Documentation

constructFilename()

std::string ProcessLib::OutputXDMFHDF5Format::constructFilename ( std::string const & mesh_name, int const timestep, double const t, int const iteration, bool const converged ) const

overridevirtual

Implements ProcessLib::OutputFormat.

Definition at line 103 of file OutputFormat.cpp.

{
    return BaseLib::constructFormattedFileName(prefix, mesh_name, timestep, t,
                                               iteration, converged) +
           ".xdmf";
}

References BaseLib::constructFormattedFileName(), and ProcessLib::OutputFormat::prefix.

Referenced by outputMeshXdmf().

outputMeshes()

void ProcessLib::OutputXDMFHDF5Format::outputMeshes ( const int timestep, const double t, const int iteration, bool const converged, std::vector< std::reference_wrapper< const MeshLib::Mesh > > const & meshes, std::set< std::string > const & output_variables ) const

inlineoverridevirtual

Implements ProcessLib::OutputFormat.

Definition at line 108 of file OutputFormat.h.

    {
        outputMeshXdmf(output_variables, meshes, timestep, t, iteration,
                       converged);
    }

References outputMeshXdmf().

outputMeshXdmf()

void ProcessLib::OutputXDMFHDF5Format::outputMeshXdmf	(	std::set< std::string > const &	output_variables,
		std::vector< std::reference_wrapper< const MeshLib::Mesh > > const &	meshes,
		int const	timestep,
		double const	t,
		int const	iteration,
		bool const	converged ) const

Definition at line 112 of file OutputFormat.cpp.

{
    // \TODO The XdmfOutput will create on construction the XdmfHdfWriter
    if (!mesh_xdmf_hdf_writer)
    {
        auto name = constructFilename(meshes[0].get().getName(), timestep, t,
                                      iteration, converged);
        std::filesystem::path path(BaseLib::joinPaths(directory, name));
        mesh_xdmf_hdf_writer = std::make_unique<MeshLib::IO::XdmfHdfWriter>(
            meshes, path, timestep, t, output_variables, static_variables,
            compression, n_files, chunk_size_bytes,
            store_static_data_separately);
    }
    else
    {
        mesh_xdmf_hdf_writer->writeStep(t);
    };
}

References chunk_size_bytes, ProcessLib::OutputFormat::compression, constructFilename(), ProcessLib::OutputFormat::directory, getName(), BaseLib::joinPaths(), mesh_xdmf_hdf_writer, n_files, static_variables, and store_static_data_separately.

Referenced by outputMeshes().

Member Data Documentation

chunk_size_bytes

unsigned int const ProcessLib::OutputXDMFHDF5Format::chunk_size_bytes

Specifies the chunks size in bytes per hdf5 output file.

Definition at line 130 of file OutputFormat.h.

Referenced by OutputXDMFHDF5Format(), and outputMeshXdmf().

mesh_xdmf_hdf_writer

std::unique_ptr<MeshLib::IO::XdmfHdfWriter> ProcessLib::OutputXDMFHDF5Format::mesh_xdmf_hdf_writer

mutable

Definition at line 123 of file OutputFormat.h.

Referenced by outputMeshXdmf().

n_files

unsigned int ProcessLib::OutputXDMFHDF5Format::n_files

Specifies the number of hdf5 output files.

Definition at line 128 of file OutputFormat.h.

Referenced by OutputXDMFHDF5Format(), and outputMeshXdmf().

static_variables

std::set<std::string> const ProcessLib::OutputXDMFHDF5Format::static_variables

user-declared time-independent output variables (in addition to the always-static built-in fields)

Definition at line 126 of file OutputFormat.h.

Referenced by OutputXDMFHDF5Format(), and outputMeshXdmf().

store_static_data_separately

bool const ProcessLib::OutputXDMFHDF5Format::store_static_data_separately

split static and dynamic data output to separate files

Definition at line 132 of file OutputFormat.h.

Referenced by OutputXDMFHDF5Format(), and outputMeshXdmf().

---

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

• OutputFormat.h
• OutputFormat.cpp