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::BinaryOutputInitialConditions
	Writes the particles when crossing the hypersurface to the binary file. More...
class	smash::HepMcInterface
	Base class for output handlers that need the HepMC3 structure. More...
class	smash::HepMcOutput
	SMASH output to HepMC file. More...
class	smash::ICOutput
	SMASH output in ASCII format containing initial conditions for hydrodynamic codes. More...
class	smash::OscarOutput< Format, Contents >
struct	smash::EventInfo
	Structure to contain custom data for output. More...
struct	smash::EventLabel
	Structure to contain information about the event and ensemble numbers. More...
class	smash::OutputInterface
	Abstraction of generic output. More...
class	smash::RivetOutput
	SMASH output to Rivet analyses. More...
class	smash::RootOutput
class	smash::ThermodynamicLatticeOutput
	Writes the thermodynamic quantities at lattice points versus time. 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 , smash::ASCII }
	Selector for the output format of OscarOutput. More...
enum	smash::OscarOutputContents {   smash::OscarInteractions = 0x001 , smash::OscarTimesteps = 0x002 , smash::OscarAtEventstart = 0x004 , smash::OscarParticlesAtEventend = 0x008 ,   smash::OscarParticlesAtEventendIfNotEmpty = 0x010 , smash::OscarParticlesIC = 0x020 }
	Flags for the Contents template parameter of OscarOutput. More...

Functions
std::unique_ptr< OutputInterface >	smash::create_binary_output (const std::string &format, const std::string &content, const std::filesystem::path &path, const OutputParameters &out_par)
	Create a binary output object. More...
	smash::OscarOutput< Format, Contents >::OscarOutput (const std::filesystem::path &path, const std::string &name, const std::vector< std::string > quantities={})
	Create oscar output. More...
void	smash::OscarOutput< Format, Contents >::at_eventstart (const Particles &particles, const EventLabel &event_label, const EventInfo &event) override
	Writes the initial particle information of an event to the oscar output. More...
void	smash::OscarOutput< Format, Contents >::at_eventend (const Particles &particles, const EventLabel &event_label, const EventInfo &event) override
	Writes the final particle information of an event to the oscar output. More...
void	smash::OscarOutput< Format, Contents >::at_interaction (const Action &action, const double density) override
	Writes a interaction prefix line and a line for every incoming and outgoing particle to the oscar output. More...
void	smash::OscarOutput< Format, Contents >::at_intermediate_time (const Particles &particles, const std::unique_ptr< Clock > &clock, const DensityParameters &dens_param, const EventLabel &event_label, const EventInfo &event) override
	Writes a prefix line then write out all current particles. More...
void	smash::OscarOutput< Format, Contents >::write_particledata (const ParticleData &data)
	Write single particle information line to output. More...
void	smash::OscarOutput< Format, Contents >::write (const Particles &particles)
	Write the particle information of a list of particles to the output. More...
std::unique_ptr< OutputInterface >	smash::create_oscar_output (const std::string &format, const std::string &content, const std::filesystem::path &path, const OutputParameters &out_par)

Variables
RenamingFilePtr	smash::OscarOutput< Format, Contents >::file_
	Full filepath of the output file. More...
OutputFormatter< ToASCII >	smash::OscarOutput< Format, Contents >::formatter_
	Formatter of the output. More...

Enumeration Type Documentation

OscarOutputFormat

enum smash::OscarOutputFormat

Selector for the output format of OscarOutput.

Enumerator
OscarFormat2013
OscarFormat2013Extended
OscarFormat1999
ASCII

Definition at line 31 of file oscaroutput.h.

                       {
  OscarFormat2013,
  OscarFormat2013Extended,
  OscarFormat1999,
  ASCII
};

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)
OscarParticlesAtEventendIfNotEmpty	store the state at the end of each event if it is not empty (at_eventend)
OscarParticlesIC	store the particles that are removed on the hypersurface

Definition at line 45 of file oscaroutput.h.

                         {
  OscarInteractions = 0x001,
  OscarTimesteps = 0x002,
  OscarAtEventstart = 0x004,
  OscarParticlesAtEventend = 0x008,
  OscarParticlesAtEventendIfNotEmpty = 0x010,
  OscarParticlesIC = 0x020
};

Function Documentation

create_binary_output()

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

Create a binary output object.

This is a helper function for the Experiment class to facilitate the logic when creating the output objects.

Parameters

[in]	format	The output format as string, e.g. "Oscar2013"
[in]	content	The output content as string, e.g. "Particles"
[in]	path	The path to the output directory
[in]	out_par	The output parameters object containing output metadata

Returns

A std::unique_ptr<OutputInterface> polymorphically initialised to the correct binary output object.

Definition at line 476 of file binaryoutput.cc.

                                                                    {
  if (content == "Particles") {
    return std::make_unique<BinaryOutputParticles>(
        path, content, out_par,
        get_list_of_binary_quantities(content, format, out_par));
  } else if (content == "Collisions" || content == "Dileptons" ||
             content == "Photons") {
    return std::make_unique<BinaryOutputCollisions>(
        path, content, out_par,
        get_list_of_binary_quantities(content, format, out_par));
  } else if (content == "Initial_Conditions") {
    return std::make_unique<BinaryOutputInitialConditions>(
        path, content, get_list_of_binary_quantities(content, format, out_par));
  } else {
    throw std::invalid_argument("Binary output not available for '" + content +
                                "' content.");
  }
}

OscarOutput()

template<OscarOutputFormat Format, int Contents>

smash::OscarOutput< Format, Contents >::OscarOutput	(	const std::filesystem::path &	path,
		const std::string &	name,
		const std::vector< std::string >	quantities = {}
	)

Create oscar output.

Parameters

[in]	path	Output path.
[in]	name	Name of the ouput.
[in]	quantities	List of quantities present in the output file.

at_eventstart()

template<OscarOutputFormat Format, int Contents>

void smash::OscarOutput< Format, Contents >::at_eventstart ( const Particles &  particles, const EventLabel &  event_label, const EventInfo &  event  )

overridevirtual

Writes the initial particle information of an event to the oscar output.

Parameters

[in]	particles	Current list of all particles.
[in]	event_label	Numbers of event and ensemble.
[in]	event	Event info, see event_info

Reimplemented from smash::OutputInterface.

Definition at line 137 of file oscaroutput.cc.

                                                                     {
  // We do not want the inital particle list or number to be printed in case of
  // IC output
  if (Contents & OscarAtEventstart && !(Contents & OscarParticlesIC)) {
    if (Format == ASCII || Format == OscarFormat2013 ||
        Format == OscarFormat2013Extended) {
      std::fprintf(file_.get(), "# event %i ensemble %i in %zu\n",
                   event_label.event_number, event_label.ensemble_number,
                   particles.size());
    } else {
      /* OSCAR line prefix : initial particles; final particles; event id
       * First block of an event: initial = 0, final = number of particles
       */
      const size_t zero = 0;
      std::fprintf(file_.get(), "%zu %zu %i %i\n", zero, particles.size(),
                   event_label.event_number, event_label.ensemble_number);
    }
    write(particles);
  } else if (Contents & OscarParticlesIC) {
    if (Format == ASCII || Format == OscarFormat2013 ||
        Format == OscarFormat2013Extended) {
      std::fprintf(file_.get(), "# event %i ensemble %i start\n",
                   event_label.event_number, event_label.ensemble_number);
    } else if (Format == OscarFormat1999) {
      const size_t zero = 0;
      std::fprintf(file_.get(), "%zu %zu %i %i\n", zero, zero,
                   event_label.event_number, event_label.ensemble_number);
    }
  }
}

at_eventend()

template<OscarOutputFormat Format, int Contents>

void smash::OscarOutput< Format, Contents >::at_eventend ( const Particles &  particles, const EventLabel &  event_label, const EventInfo &  event  )

overridevirtual

Writes the final particle information of an event to the oscar output.

Parameters

[in]	particles	Current list of particles.
[in]	event_label	Numbers of event and ensemble.
[in]	event	Event info, see event_info

Reimplemented from smash::OutputInterface.

Definition at line 171 of file oscaroutput.cc.

                                                                        {
  if (Format == ASCII || Format == OscarFormat2013 ||
      Format == OscarFormat2013Extended) {
    if (Contents & OscarParticlesAtEventend ||
        (Contents & OscarParticlesAtEventendIfNotEmpty && !event.empty_event)) {
      std::fprintf(file_.get(), "# event %i ensemble %i out %zu\n",
                   event_label.event_number, event_label.ensemble_number,
                   particles.size());
      write(particles);
    }
    // Comment end of an event
    if (!(Contents & OscarParticlesIC)) {
      const char *empty_event_str = event.empty_event ? "no" : "yes";
      std::fprintf(file_.get(),
                   "# event %i ensemble %i end 0 impact %7.3f "
                   "scattering_projectile_target %s\n",
                   event_label.event_number, event_label.ensemble_number,
                   event.impact_parameter, empty_event_str);
    } else {
      std::fprintf(file_.get(), "# event %i ensemble %i end\n",
                   event_label.event_number, event_label.ensemble_number);
    }
  } else {
    /* OSCAR line prefix : initial particles; final particles; event id
     * Last block of an event: initial = number of particles, final = 0
     * Block ends with null interaction. */
    const size_t zero = 0;
    if (Contents & OscarParticlesAtEventend ||
        (Contents & OscarParticlesAtEventendIfNotEmpty && !event.empty_event)) {
      std::fprintf(file_.get(), "%zu %zu %i %i\n", particles.size(), zero,
                   event_label.event_number, event_label.ensemble_number);
      write(particles);
    }
    // Null interaction marks the end of an event
    std::fprintf(file_.get(), "%zu %zu %i %i %7.3f\n", zero, zero,
                 event_label.event_number, event_label.ensemble_number,
                 event.impact_parameter);
  }
  // Flush to disk
  std::fflush(file_.get());
 
  if (Contents & OscarParticlesIC) {
    // If the runtime is too short some particles might not yet have
    // reached the hypersurface. Warning is printed.
    if (particles.size() != 0 && !event.impose_kinematic_cut_for_SMASH_IC) {
      logg[LHyperSurfaceCrossing].warn(
          "End time might be too small for initial conditions output. "
          "Hypersurface has not yet been crossed by ",
          particles.size(), " particle(s).");
    }
  }
}

at_interaction()

template<OscarOutputFormat Format, int Contents>

void smash::OscarOutput< Format, Contents >::at_interaction ( const Action &  action, const double  density  )

overridevirtual

Writes a interaction prefix line and a line for every incoming and outgoing particle to the oscar output.

Parameters

[in]	action	Action that holds the information of the interaction.
[in]	density	Density at the interaction point.

Reimplemented from smash::OutputInterface.

Definition at line 227 of file oscaroutput.cc.

                                                                         {
  if (Contents & OscarInteractions) {
    if (Format == ASCII || Format == OscarFormat2013 ||
        Format == OscarFormat2013Extended) {
      std::fprintf(file_.get(),
                   "# interaction in %zu out %zu rho %12.7f weight %12.7g"
                   " partial %12.7f type %5i\n",
                   action.incoming_particles().size(),
                   action.outgoing_particles().size(), density,
                   action.get_total_weight(), action.get_partial_weight(),
                   static_cast<int>(action.get_type()));
    } else {
      /* OSCAR line prefix : initial final
       * particle creation: 0 1
       * particle 2<->2 collision: 2 2
       * resonance formation: 2 1
       * resonance decay: 1 2
       * etc.*/
      std::fprintf(file_.get(), "%zu %zu %12.7f %12.7f %12.7f %5i\n",
                   action.incoming_particles().size(),
                   action.outgoing_particles().size(), density,
                   action.get_total_weight(), action.get_partial_weight(),
                   static_cast<int>(action.get_type()));
    }
    for (const auto &p : action.incoming_particles()) {
      write_particledata(p);
    }
    for (const auto &p : action.outgoing_particles()) {
      write_particledata(p);
    }
  } else if (Contents & OscarParticlesIC) {
    for (const auto &p : action.incoming_particles()) {
      write_particledata(p);
    }
  }
}

at_intermediate_time()

template<OscarOutputFormat Format, int Contents>

void smash::OscarOutput< Format, Contents >::at_intermediate_time ( const Particles &  particles, const std::unique_ptr< Clock > &  clock, const DensityParameters &  dens_param, const EventLabel &  event_label, const EventInfo &  event  )

overridevirtual

Writes a prefix line then write out all current particles.

Parameters

[in]	particles	Current list of particles.
[in]	clock	Unused, needed since inherited.
[in]	dens_param	Unused, needed since inherited.
[in]	event_label	Numbers of event and ensemble.
[in]	event	Event info, see event_info

Reimplemented from smash::OutputInterface.

Definition at line 266 of file oscaroutput.cc.

                       {
  if (Contents & OscarTimesteps) {
    if (Format == ASCII || Format == OscarFormat2013 ||
        Format == OscarFormat2013Extended) {
      std::fprintf(file_.get(), "# event %i ensemble %i out %zu\n",
                   event_label.event_number, event_label.ensemble_number,
                   particles.size());
    } else {
      const size_t zero = 0;
      std::fprintf(file_.get(), "%zu %zu %i %i\n", particles.size(), zero,
                   event_label.event_number, event_label.ensemble_number);
    }
    write(particles);
  }
}

write_particledata()

template<OscarOutputFormat Format, int Contents>

void smash::OscarOutput< Format, Contents >::write_particledata ( const ParticleData &  data )

private

Write single particle information line to output.

Parameters

[in]

data

Data of particle.

Definition at line 842 of file oscaroutput.cc.

                              {
  std::fprintf(file_.get(), "%s\n", formatter_.data_line(data).c_str());
}

write()

template<OscarOutputFormat Format, int Contents>

void smash::OscarOutput< Format, Contents >::write ( const Particles &  particles )

inlineprivate

Write the particle information of a list of particles to the output.

One line per particle.

Parameters

[in]

particles

List of particles to be written

Definition at line 130 of file oscaroutput.cc.

                                                                           {
  for (const ParticleData &data : particles) {
    write_particledata(data);
  }
}

create_oscar_output()

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

Returns

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

Parameters

[in]	format	The output format as string, e.g. "Oscar2013"
[in]	content	The output content as string, e.g. "Particles"
[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 889 of file oscaroutput.cc.

                                                                    {
  if (format != "Oscar2013" && format != "Oscar1999" && format != "ASCII") {
    throw std::invalid_argument("Creating Oscar output: unknown format");
  }
  const bool modern_format = (format == "Oscar2013");
  const bool custom_format = (format == "ASCII");
  if (content == "Particles") {
    if (out_par.part_only_final == OutputOnlyFinal::Yes) {
      return create_select_format<OscarParticlesAtEventend>(
          modern_format, path, out_par, "particle_lists", custom_format);
    } else if (out_par.part_only_final == OutputOnlyFinal::IfNotEmpty) {
      return create_select_format<OscarParticlesAtEventendIfNotEmpty>(
          modern_format, path, out_par, "particle_lists", custom_format);
 
    } else {  // out_par.part_only_final == OutputOnlyFinal::No
      return create_select_format<OscarTimesteps | OscarAtEventstart |
                                  OscarParticlesAtEventend>(
          modern_format, path, out_par, "particle_lists", custom_format);
    }
  } else if (content == "Collisions") {
    if (out_par.coll_printstartend) {
      return create_select_format<OscarInteractions | OscarAtEventstart |
                                  OscarParticlesAtEventend>(
          modern_format, path, out_par, "full_event_history", custom_format);
    } else {
      return create_select_format<OscarInteractions>(
          modern_format, path, out_par, "full_event_history", custom_format);
    }
  } else if (content == "Dileptons") {
    if (modern_format && out_par.dil_extended) {
      return std::make_unique<
          OscarOutput<OscarFormat2013Extended, OscarInteractions>>(path,
                                                                   "Dileptons");
    } else if (modern_format && !out_par.dil_extended) {
      return std::make_unique<OscarOutput<OscarFormat2013, OscarInteractions>>(
          path, "Dileptons");
    } else if (!modern_format && !out_par.dil_extended) {
      return std::make_unique<OscarOutput<OscarFormat1999, OscarInteractions>>(
          path, "Dileptons");
    } else if (!custom_format && !modern_format && out_par.dil_extended) {
      logg[LOutput].warn()
          << "Creating Oscar output: "
          << "There is no extended Oscar1999 (dileptons) format.";
    }
  } else if (content == "Photons") {
    if (modern_format && !out_par.photons_extended) {
      return std::make_unique<OscarOutput<OscarFormat2013, OscarInteractions>>(
          path, "Photons");
    } else if (modern_format && out_par.photons_extended) {
      return std::make_unique<
          OscarOutput<OscarFormat2013Extended, OscarInteractions>>(path,
                                                                   "Photons");
    } else if (!modern_format && !out_par.photons_extended) {
      return std::make_unique<OscarOutput<OscarFormat1999, OscarInteractions>>(
          path, "Photons");
    } else if (!custom_format && !modern_format && out_par.photons_extended) {
      logg[LOutput].warn()
          << "Creating Oscar output: "
          << "There is no extended Oscar1999 (photons) format.";
    }
  } else if (content == "Initial_Conditions") {
    if (modern_format && !out_par.ic_extended) {
      return std::make_unique<
          OscarOutput<OscarFormat2013, OscarParticlesIC | OscarAtEventstart>>(
          path, "SMASH_IC");
    } else if (modern_format && out_par.ic_extended) {
      return std::make_unique<OscarOutput<
          OscarFormat2013Extended, OscarParticlesIC | OscarAtEventstart>>(
          path, "SMASH_IC");
    } else if (!modern_format && !out_par.ic_extended) {
      return std::make_unique<
          OscarOutput<OscarFormat1999, OscarParticlesIC | OscarAtEventstart>>(
          path, "SMASH_IC");
    } else if (!custom_format && !modern_format && out_par.ic_extended) {
      logg[LOutput].warn()
          << "Creating Oscar output: "
          << "There is no extended Oscar1999 (initial conditions) format.";
    }
  }
 
  throw std::invalid_argument("Create_oscar_output got unknown content.");
}

Variable Documentation

file_

template<OscarOutputFormat Format, int Contents>

RenamingFilePtr smash::OscarOutput< Format, Contents >::file_

private

Full filepath of the output file.

Definition at line 136 of file oscaroutput.h.

formatter_

template<OscarOutputFormat Format, int Contents>

OutputFormatter<ToASCII> smash::OscarOutput< Format, Contents >::formatter_

private

Formatter of the output.

Definition at line 139 of file oscaroutput.h.