Output Classes

Classes
class	smash::BinaryOutputBase
	Base class for SMASH binary output. More...
class	smash::BinaryOutputCollisions
	Saves SMASH collision history to binary file. More...
class	smash::BinaryOutputParticles
	Writes the particle list at specific times to the binary file. More...
class	smash::OscarOutput< Format, Contents >
class	smash::OutputInterface
	Abstraction of generic output. More...
class	smash::RootOutput
	SMASH output to ROOT file SMASH supports ROOT output as an option (see http://root.cern.ch). More...
class	smash::ThermodynamicOutput
	Writes the thermodynamic quantities at a specified point versus time. More...
class	smash::VtkOutput
	SMASH output in a paraview format, intended for simple visualization. More...

Enumerations
enum	smash::OscarOutputFormat { smash::OscarFormat2013, smash::OscarFormat2013Extended, smash::OscarFormat1999 }
	Selector for the output format of OscarOutput. More...
enum	smash::OscarOutputContents { smash::OscarInteractions = 0x001, smash::OscarTimesteps = 0x002, smash::OscarAtEventstart = 0x004, smash::OscarParticlesAtEventend = 0x008 }
	Flags for the Contents template parameter of OscarOutput. More...

Functions
std::unique_ptr< OutputInterface >	smash::create_oscar_output (const std::string &format, const std::string &content, const bf::path &path, const OutputParameters &out_par)

Enumeration Type Documentation

OscarOutputFormat

enum smash::OscarOutputFormat

Selector for the output format of OscarOutput.

Enumerator
OscarFormat2013
OscarFormat2013Extended
OscarFormat1999

Definition at line 29 of file oscaroutput.h.

                       {
  OscarFormat2013,
  OscarFormat2013Extended,
  OscarFormat1999
};

OscarOutputContents

enum smash::OscarOutputContents

Flags for the Contents template parameter of OscarOutput.

Flags can be combined with binary OR operators to some arbitrary int. That's why the values of the enumerators are written out (in hexadecimal), to ensure every flag occupies a single bit.

Enumerator
OscarInteractions	store interaction information (write_interaction)
OscarTimesteps	store the state after N timesteps (after_Nth_timestep)
OscarAtEventstart	store the state at the start of each event (at_eventstart)
OscarParticlesAtEventend	store the state at the end of each event (at_eventend)

Definition at line 42 of file oscaroutput.h.

                         {
  OscarInteractions = 0x001,
  OscarTimesteps = 0x002,
  OscarAtEventstart = 0x004,
  OscarParticlesAtEventend = 0x008
};

Function Documentation

create_oscar_output()

std::unique_ptr< OutputInterface > smash::create_oscar_output	(	const std::string &	format,
		const std::string &	content,
		const bf::path &	path,
		const OutputParameters &	out_par
	)

Returns

A new OscarOutput object using information from config to select the correct implementation.

Parameters

[in]	format	A string: "Oscar2013" or "Oscar1999"
[in]	content	A string: "Particles", "Collisions", "Photons" or "Dileptons".
[in]	path	The path to the output directory where the file(s) will be placed.
[in]	out_par	A structure containing parameters of the output, in particular if it is extended or not, if printing only final particles in event, etc.

Definition at line 732 of file oscaroutput.cc.

                                     {
  const auto &log = logger<LogArea::Output>();
  if (format != "Oscar2013" && format != "Oscar1999") {
    throw std::invalid_argument("Creating Oscar output: unknown format");
  }
  const bool modern_format = (format == "Oscar2013");
  if (content == "Particles") {
    if (out_par.part_only_final) {
      return create_select_format<OscarParticlesAtEventend>(
          modern_format, path, out_par, "particle_lists");
    } else {
      return create_select_format<OscarTimesteps | OscarAtEventstart |
                                  OscarParticlesAtEventend>(
          modern_format, path, out_par, "particle_lists");
    }
  } else if (content == "Collisions") {
    if (out_par.coll_printstartend) {
      return create_select_format<OscarInteractions | OscarAtEventstart |
                                  OscarParticlesAtEventend>(
          modern_format, path, out_par, "full_event_history");
    } else {
      return create_select_format<OscarInteractions>(
          modern_format, path, out_par, "full_event_history");
    }
  } else if (content == "Dileptons") {
    if (modern_format && out_par.dil_extended) {
      return make_unique<
          OscarOutput<OscarFormat2013Extended, OscarInteractions>>(path,
                                                                   "Dileptons");
    } else if (modern_format && !out_par.dil_extended) {
      return make_unique<OscarOutput<OscarFormat2013, OscarInteractions>>(
          path, "Dileptons");
    } else if (!modern_format && !out_par.dil_extended) {
      return make_unique<OscarOutput<OscarFormat1999, OscarInteractions>>(
          path, "Dileptons");
    } else if (!modern_format && out_par.dil_extended) {
      log.warn() << "Creating Oscar output: "
                 << "There is no extended Oscar1999 (dileptons) format.";
    }
  } else if (content == "Photons") {
    if (modern_format && !out_par.photons_extended) {
      return make_unique<OscarOutput<OscarFormat2013, OscarInteractions>>(
          path, "Photons");
    } else if (modern_format && out_par.photons_extended) {
      return make_unique<
          OscarOutput<OscarFormat2013Extended, OscarInteractions>>(path,
                                                                   "Photons");
    } else if (!modern_format && !out_par.photons_extended) {
      return make_unique<OscarOutput<OscarFormat1999, OscarInteractions>>(
          path, "Photons");
    } else if (!modern_format && out_par.photons_extended) {
      log.warn() << "Creating Oscar output: "
                 << "There is no extended Oscar1999 (photons) format.";
    }
  }

  throw std::invalid_argument("Create_oscar_output got unknown content.");
}

Here is the call graph for this function:

Here is the caller graph for this function: