smash::OscarOutput< Format, Contents > Class Template Reference

#include <oscaroutput.h>

template<OscarOutputFormat Format, int Contents>
class smash::OscarOutput< Format, Contents >

Template Parameters

Format	Determines the variant of OSCAR formatting that is used. See OscarOutputFormat.
Contents	Determines what information will be written to file. This integer is a bitflag that can be constructed from ORing enumerators from OscarOutputContents together.

Definition at line 63 of file oscaroutput.h.

Inheritance diagram for smash::OscarOutput< Format, Contents >:

Collaboration diagram for smash::OscarOutput< Format, Contents >:

Public Member Functions
	OscarOutput (const bf::path &path, const std::string &name)
	Create oscar output. More...
void	at_eventstart (const Particles &particles, const int event_number) override
	Writes the initial particle information of an event to the oscar output. More...
void	at_eventend (const Particles &particles, const int event_number, double impact_parameter, bool empty_event) override
	Writes the final particle information of an event to the oscar output. More...
void	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	at_intermediate_time (const Particles &particles, const std::unique_ptr< Clock > &clock, const DensityParameters &dens_param) override
	Writes a prefix line then write out all current particles. More...
Public Member Functions inherited from smash::OutputInterface
	OutputInterface (std::string name)
	Construct output interface. More...
virtual	~OutputInterface ()=default
virtual void	thermodynamics_output (const ThermodynamicQuantity tq, const DensityType dt, RectangularLattice< DensityOnLattice > &lattice)
	Output to write thermodynamics from the lattice. More...
virtual void	thermodynamics_output (const ThermodynamicQuantity tq, const DensityType dt, RectangularLattice< EnergyMomentumTensor > &lattice)
	Output to write energy-momentum tensor and related quantities from the lattice. More...
virtual void	thermodynamics_output (const GrandCanThermalizer &gct)
	Output to write energy-momentum tensor and related quantities from the thermalizer class. More...
bool	is_dilepton_output () const
	Get, whether this is the dilepton output? More...
bool	is_photon_output () const
	Get, whether this is the photon output? More...
bool	is_IC_output () const
	Get, whether this is the IC output? More...
const char *	to_string (const ThermodynamicQuantity tq)
	Convert thermodynamic quantities to strings. More...
const char *	to_string (const DensityType dens_type)
	Convert density types to strings. More...

Private Member Functions
void	write_particledata (const ParticleData &data)
	Write single particle information line to output. More...
void	write (const Particles &particles)
	Write the particle information of a list of particles to the output. More...

Private Attributes
int	current_event_ = 0
	Keep track of event number. More...
RenamingFilePtr	file_
	Full filepath of the output file. More...

Additional Inherited Members
Protected Attributes inherited from smash::OutputInterface
const bool	is_dilepton_output_
	Is this the dilepton output? More...
const bool	is_photon_output_
	Is this the photon output? More...
const bool	is_IC_output_
	Is this the IC output? More...

Constructor & Destructor Documentation

template<OscarOutputFormat Format, int Contents>

smash::OscarOutput< Format, Contents >::OscarOutput	(	const bf::path &	path,
		const std::string &	name
	)

Create oscar output.

Parameters

[in]	path	Output path.
[in]	name	Name of the ouput.

Member Function Documentation

template<OscarOutputFormat Format, int Contents>

void smash::OscarOutput< Format, Contents >::at_eventstart ( const Particles &  particles, const int  event_number  )

overridevirtual

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

Parameters

[in]	particles	Current list of all particles.
[in]	event_number	Number of event.

Implements smash::OutputInterface.

Definition at line 126 of file oscaroutput.cc.

                                                                          {
  current_event_ = event_number;
  if (Contents & OscarAtEventstart) {
    if (Format == OscarFormat2013 || Format == OscarFormat2013Extended) {
      std::fprintf(file_.get(), "# event %i in %zu\n", event_number + 1,
                   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\n", zero, particles.size(),
                   event_number + 1);
    }
    if (!(Contents == OscarParticlesIC)) {
      // We do not want the inital particle list to be printed in case of IC
      // output
      write(particles);
    }
  }
}

Here is the call graph for this function:

template<OscarOutputFormat Format, int Contents>

void smash::OscarOutput< Format, Contents >::at_eventend ( const Particles &  particles, const int  event_number, double  impact_parameter, bool  empty_event  )

overridevirtual

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

Parameters

[in]	particles	Current list of particles.
[in]	event_number	Number of event.
[in]	impact_parameter	Impact parameter of this event.
[in]	empty_event	Whether there was no interaction between the target and the projectile.

Implements smash::OutputInterface.

Definition at line 150 of file oscaroutput.cc.

                                                                  {
  if (Format == OscarFormat2013 || Format == OscarFormat2013Extended) {
    if (Contents & OscarParticlesAtEventend) {
      std::fprintf(file_.get(), "# event %i out %zu\n", event_number + 1,
                   particles.size());
      write(particles);
    }
    // Comment end of an event
    const char *empty_event_str = empty_event ? "yes" : "no";
    std::fprintf(file_.get(), "# event %i end 0 impact %7.3f empty %s\n",
                 event_number + 1, impact_parameter, empty_event_str);
  } 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) {
      std::fprintf(file_.get(), "%zu %zu %i\n", particles.size(), zero,
                   event_number + 1);
      write(particles);
    }
    // Null interaction marks the end of an event
    std::fprintf(file_.get(), "%zu %zu %i %7.3f\n", zero, zero,
                 event_number + 1, impact_parameter);
  }
  // Flush to disk
  std::fflush(file_.get());

  if (Contents == OscarParticlesIC) {
    const auto &log = logger<LogArea::HyperSurfaceCrossing>();
    // If the runtime is too short some particles might not yet have
    // reached the hypersurface. Warning is printed.
    if (particles.size() != 0) {
      log.warn(
          "End time might be too small for initial conditions output. "
          "Hypersurface has not yet been crossed by ",
          particles.size(), " particle(s).");
    }
  }
}

Here is the call graph for this function:

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 195 of file oscaroutput.cc.

                                                                         {
  if (Contents & OscarInteractions) {
    if (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);
    }
  }
}

Here is the call graph for this function:

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  )

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.

Reimplemented from smash::OutputInterface.

Definition at line 233 of file oscaroutput.cc.

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

Here is the call graph for this function:

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 700 of file oscaroutput.cc.

                              {
  const FourVector pos = data.position();
  const FourVector mom = data.momentum();
  if (Format == OscarFormat2013) {
    std::fprintf(file_.get(), "%g %g %g %g %g %.9g %.9g %.9g %.9g %s %i %i\n",
                 pos.x0(), pos.x1(), pos.x2(), pos.x3(), data.effective_mass(),
                 mom.x0(), mom.x1(), mom.x2(), mom.x3(),
                 data.pdgcode().string().c_str(), data.id(),
                 data.type().charge());
  } else if (Format == OscarFormat2013Extended) {
    const auto h = data.get_history();
    std::fprintf(
        file_.get(),
        "%g %g %g %g %g %.9g %.9g %.9g"
        " %.9g %s %i %i %i %g %g %i %i %g %s %s\n",
        pos.x0(), pos.x1(), pos.x2(), pos.x3(), data.effective_mass(), mom.x0(),
        mom.x1(), mom.x2(), mom.x3(), data.pdgcode().string().c_str(),
        data.id(), data.type().charge(), h.collisions_per_particle,
        data.formation_time(), data.xsec_scaling_factor(), h.id_process,
        static_cast<int>(h.process_type), h.time_last_collision,
        h.p1.string().c_str(), h.p2.string().c_str());
  } else {
    std::fprintf(file_.get(), "%i %s %i %g %g %g %g %g %g %g %g %g\n",
                 data.id(), data.pdgcode().string().c_str(), 0, mom.x1(),
                 mom.x2(), mom.x3(), mom.x0(), data.effective_mass(), pos.x1(),
                 pos.x2(), pos.x3(), pos.x0());
  }
}

Here is the call graph for this function:

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 119 of file oscaroutput.cc.

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

Member Data Documentation

template<OscarOutputFormat Format, int Contents>

int smash::OscarOutput< Format, Contents >::current_event_ = 0

private

Keep track of event number.

Definition at line 126 of file oscaroutput.h.

template<OscarOutputFormat Format, int Contents>

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

private

Full filepath of the output file.

Definition at line 129 of file oscaroutput.h.

---

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

• src/include/smash/oscaroutput.h
• src/oscaroutput.cc