serac::output Namespace Reference

The output related helper functions and objects. More...

Enumerations
enum class	FileFormat { JSON , YAML }
	The output file formats supported.

Functions
void	outputSummary (const axom::sidre::DataStore &datastore, const std::string &output_directory, const FileFormat file_format=FileFormat::JSON)
	Outputs simulation summary data from the datastore to the given file only on rank 0. More...

Detailed Description

The output related helper functions and objects.

Function Documentation

outputSummary()

void serac::output::outputSummary	(	const axom::sidre::DataStore &	datastore,
		const std::string &	output_directory,
		const FileFormat	file_format = FileFormat::JSON
	)

Outputs simulation summary data from the datastore to the given file only on rank 0.

Parameters

[in]	datastore	Root of the Sidre datastore
[in]	output_directory	Directory to write output file into
[in]	file_format	The output file format

Definition at line 31 of file output.cpp.