Detailed Description

Definition at line 178 of file Output.cpp.

Public Member Functions
	OutputFile (std::string const &directory, OutputType const type, std::string const &prefix, std::string const &suffix, std::string const &mesh_name, int const timestep, double const t, int const iteration, int const data_mode_, bool const compression_, std::set< std::string > const &outputnames, unsigned int const n_files)

Static Public Member Functions
static std::string	constructFilename (OutputType const type, std::string prefix, std::string suffix, std::string mesh_name, int const timestep, double const t, int const iteration)

Public Attributes
std::string const	name

std::string const	path

OutputType const	type

int const	data_mode

bool const	compression
	Enables or disables zlib-compression of the output files. More...

std::set< std::string >	outputnames

unsigned int	n_files

Constructor & Destructor Documentation

◆ OutputFile()

ProcessLib::Output::OutputFile::OutputFile	(	std::string const &	directory,
		OutputType const	type,
		std::string const &	prefix,
		std::string const &	suffix,
		std::string const &	mesh_name,
		int const	timestep,
		double const	t,
		int const	iteration,
		int const	data_mode_,
		bool const	compression_,
		std::set< std::string > const &	outputnames,
		unsigned int const	n_files
	)

inline

Definition at line 180 of file Output.cpp.

         : name(constructFilename(type, prefix, suffix, mesh_name, timestep, t,
                                  iteration)),
           path(BaseLib::joinPaths(directory, name)),
           type(type),
           data_mode(data_mode_),
           compression(compression_),
           outputnames(outputnames),
           n_files(n_files)
     {
     }

Member Function Documentation

◆ constructFilename()

static std::string ProcessLib::Output::OutputFile::constructFilename	(	OutputType const	type,
		std::string	prefix,
		std::string	suffix,
		std::string	mesh_name,
		int const	timestep,
		double const	t,
		int const	iteration
	)

inlinestatic

Definition at line 210 of file Output.cpp.

     {
         std::map<OutputType, std::string> filetype_to_extension = {
             {OutputType::vtk, "vtu"}, {OutputType::xdmf, "xdmf"}};
  
         try
         {
             std::string extension = filetype_to_extension.at(type);
             return BaseLib::constructFormattedFileName(prefix, mesh_name,
                                                        timestep, t, iteration) +
                    BaseLib::constructFormattedFileName(suffix, mesh_name,
                                                        timestep, t, iteration) +
                    "." + extension;
         }
         catch (std::out_of_range&)
         {
             OGS_FATAL(
                 "No supported file type provided. Read `{:s}' from <output><type> \
                     in prj file. Supported: VTK, XDMF.",
                 type);
         }
     }

References BaseLib::constructFormattedFileName(), OGS_FATAL, type, ProcessLib::vtk, and ProcessLib::xdmf.

Referenced by ProcessLib::Output::doOutputNonlinearIteration().

Member Data Documentation

◆ compression

bool const ProcessLib::Output::OutputFile::compression

Enables or disables zlib-compression of the output files.

Definition at line 207 of file Output.cpp.

Referenced by ProcessLib::Output::outputMesh(), and ProcessLib::Output::outputMeshXdmf().

◆ data_mode

int const ProcessLib::Output::OutputFile::data_mode

Chooses vtk's data mode for output following the enumeration given in the vtkXMLWriter: {Ascii, Binary, Appended}. See vtkXMLWriter documentation http://www.vtk.org/doc/nightly/html/classvtkXMLWriter.html

Definition at line 205 of file Output.cpp.

Referenced by ProcessLib::Output::outputMesh().

◆ n_files

unsigned int ProcessLib::Output::OutputFile::n_files

Definition at line 209 of file Output.cpp.

Referenced by ProcessLib::Output::outputMeshXdmf().

◆ name

std::string const ProcessLib::Output::OutputFile::name

Definition at line 198 of file Output.cpp.

Referenced by ProcessLib::Output::outputMesh().

◆ outputnames

std::set<std::string> ProcessLib::Output::OutputFile::outputnames

Definition at line 208 of file Output.cpp.

◆ path

std::string const ProcessLib::Output::OutputFile::path

Definition at line 199 of file Output.cpp.

Referenced by ProcessLib::Output::outputMesh(), and ProcessLib::Output::outputMeshXdmf().

◆ type

OutputType const ProcessLib::Output::OutputFile::type

Definition at line 200 of file Output.cpp.

Referenced by constructFilename(), and ProcessLib::Output::outputMesh().

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

ProcessLib/Output/Output.cpp