OGS
List of all members | Public Member Functions | Public Attributes
ProcessLib::OutputFormat Struct Referenceabstract

Detailed Description

Definition at line 23 of file OutputFormat.h.

#include <OutputFormat.h>

Inheritance diagram for ProcessLib::OutputFormat:
[legend]

Public Member Functions

 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
 
virtual void outputMeshes (const int timestep, const double t, const int iteration, std::vector< std::reference_wrapper< const MeshLib::Mesh > > const &meshes, std::set< std::string > const &output_variables) const =0
 
virtual std::string constructFilename (std::string const &mesh_name, int const timestep, double const t, int const iteration) const =0
 

Public Attributes

std::string directory
 
std::string prefix
 
std::string suffix
 
bool compression
 Enables or disables zlib-compression of the output files.
 

Constructor & Destructor Documentation

◆ OutputFormat() [1/3]

ProcessLib::OutputFormat::OutputFormat ( std::string const & directory,
std::string prefix,
std::string suffix,
bool const compression )

Definition at line 83 of file OutputFormat.cpp.

85 : directory(directory),
86 prefix(std::move(prefix)),
87 suffix(std::move(suffix)),
88 compression(compression)
89{
90}
ProcessLib::OutputFormat::compression
bool compression
Enables or disables zlib-compression of the output files.
Definition OutputFormat.h:38

◆ ~OutputFormat()

virtual ProcessLib::OutputFormat::~OutputFormat ( )
virtualdefault

◆ OutputFormat() [2/3]

ProcessLib::OutputFormat::OutputFormat ( OutputFormat const & other)
delete

◆ OutputFormat() [3/3]

ProcessLib::OutputFormat::OutputFormat ( OutputFormat && other)
default

Member Function Documentation

◆ constructFilename()

virtual std::string ProcessLib::OutputFormat::constructFilename ( std::string const & mesh_name,
int const timestep,
double const t,
int const iteration ) const
pure virtual

Implemented in ProcessLib::OutputVTKFormat, and ProcessLib::OutputXDMFHDF5Format.

◆ operator=() [1/2]

OutputFormat & ProcessLib::OutputFormat::operator= ( OutputFormat && other)
default

◆ operator=() [2/2]

OutputFormat & ProcessLib::OutputFormat::operator= ( OutputFormat & other)
delete

◆ outputMeshes()

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

Implemented in ProcessLib::OutputVTKFormat, and ProcessLib::OutputXDMFHDF5Format.

Member Data Documentation

◆ compression

bool ProcessLib::OutputFormat::compression

Enables or disables zlib-compression of the output files.

Definition at line 38 of file OutputFormat.h.

Referenced by ProcessLib::operator<<(), ProcessLib::outputMeshVtk(), and ProcessLib::OutputXDMFHDF5Format::outputMeshXdmf().

◆ directory

std::string ProcessLib::OutputFormat::directory

Definition at line 34 of file OutputFormat.h.

Referenced by ProcessLib::OutputVTKFormat::constructPVDName(), ProcessLib::operator<<(), ProcessLib::outputMeshVtk(), and ProcessLib::OutputXDMFHDF5Format::outputMeshXdmf().

◆ prefix

std::string ProcessLib::OutputFormat::prefix

Definition at line 35 of file OutputFormat.h.

Referenced by ProcessLib::OutputVTKFormat::constructFilename(), ProcessLib::OutputXDMFHDF5Format::constructFilename(), ProcessLib::OutputVTKFormat::constructPVDName(), and ProcessLib::operator<<().

◆ suffix

std::string ProcessLib::OutputFormat::suffix

Definition at line 36 of file OutputFormat.h.

Referenced by ProcessLib::OutputVTKFormat::constructFilename(), and ProcessLib::operator<<().

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