#include <icoutput.h>

SMASH output in ASCII format containing initial conditions for hydrodynamic codes.

Formatted such that it can be directly processed by vHLLE Karpenko:2015xea [31].

Definition at line 31 of file icoutput.h.

Inheritance diagram for smash::ICOutput:

Public Member Functions
	ICOutput (const std::filesystem::path &path, const std::string &name, const OutputParameters &out_par)
	Create a new IC output. More...

	~ICOutput ()

void	at_eventstart (const Particles &, const EventLabel &event_label, const EventInfo &event) override
	Write event start line. More...

void	at_eventend (const Particles &particles, const EventLabel &event_label, const EventInfo &event) override
	Write event end line. More...

void	at_intermediate_time (const Particles &, const std::unique_ptr< Clock > &, const DensityParameters &, const EventLabel &, const EventInfo &) override
	Unused, but needed since virtually declared in mother class. More...

void	at_interaction (const Action &action, const double) override
	Write particle data at the hypersurface crossing point to the IC output. More...

Public Member Functions inherited from smash::OutputInterface
	OutputInterface (std::string name)
	Construct output interface. More...

virtual	~OutputInterface ()=0
	Pure virtual destructor to make class abstract and prevent its instantiation. More...

virtual void	at_eventstart (const std::vector< Particles > &, int)
	Output launched at event start after initialization, when particles are generated but not yet propagated. More...

virtual void	at_eventstart (const int, const ThermodynamicQuantity, const DensityType, RectangularLattice< DensityOnLattice >)
	Output launched at event start after initialization, when particles are generated but not yet propagated. More...

virtual void	at_eventstart (const int, const ThermodynamicQuantity, const DensityType, RectangularLattice< EnergyMomentumTensor >)
	Output launched at event start after initialization, when particles are generated but not yet propagated. More...

virtual void	at_eventend (const ThermodynamicQuantity)
	Output launched at event end. More...

virtual void	at_eventend (const std::vector< Particles > &, const int)
	Output launched at event end. More...

virtual void	at_intermediate_time (const std::vector< Particles > &, const std::unique_ptr< Clock > &, const DensityParameters &)
	Output launched after every N'th timestep. More...

virtual void	thermodynamics_output (const ThermodynamicQuantity, const DensityType, RectangularLattice< DensityOnLattice > &)
	Output to write thermodynamics from the lattice. More...

virtual void	thermodynamics_output (const ThermodynamicQuantity, const DensityType, RectangularLattice< EnergyMomentumTensor > &)
	Output to write energy-momentum tensor and related quantities from the lattice. More...

virtual void	thermodynamics_lattice_output (RectangularLattice< DensityOnLattice > &, const double)
	Output to write thermodynamics from the lattice. More...

virtual void	thermodynamics_lattice_output (RectangularLattice< DensityOnLattice > &, const double, const std::vector< Particles > &, const DensityParameters &)
	Output to write thermodynamics from the lattice. More...

virtual void	thermodynamics_lattice_output (const ThermodynamicQuantity, RectangularLattice< EnergyMomentumTensor > &, const double)
	Output to write energy-momentum tensor and related quantities from the lattice. More...

virtual void	thermodynamics_output (const GrandCanThermalizer &)
	Output to write energy-momentum tensor and related quantities from the thermalizer class. More...

virtual void	fields_output (const std::string, const std::string, RectangularLattice< std::pair< ThreeVector, ThreeVector >> &)
	Write fields in vtk output Fields are a pair of threevectors for example electric and magnetic field. 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 Attributes
RenamingFilePtr	file_
	Pointer to output file. More...

const OutputParameters	out_par_
	Structure that holds all the information about what to printout. More...

double	IC_proper_time_ = -1.0
	Proper time of the particles removed when extracting initial conditions. 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

◆ ICOutput()

smash::ICOutput::ICOutput	(	const std::filesystem::path &	path,
		const std::string &	name,
		const OutputParameters &	out_par
	)

Create a new IC output.

Parameters

[in]	path	Path to the output file.
[in]	name	Name of the output.
[in]	out_par	Additional information on the configured output.

Definition at line 106 of file icoutput.cc.

     : OutputInterface(name),
       file_{path / "SMASH_IC.dat", "w"},
       out_par_(out_par) {
   std::fprintf(
       file_.get(),
       "# %s initial conditions: hypersurface of constant proper time\n",
       SMASH_VERSION);
   std::fprintf(file_.get(),
                "# tau x y eta mt px py Rap pdg charge "
                "baryon_number strangeness\n");
   std::fprintf(file_.get(),
                "# fm fm fm none GeV GeV GeV none none e "
                "none none\n");
 }

◆ ~ICOutput()

smash::ICOutput::~ICOutput ( )

Definition at line 123 of file icoutput.cc.

123 {}

Member Function Documentation

◆ at_eventstart()

void smash::ICOutput::at_eventstart	(	const Particles &	,
		const EventLabel &	event_label,
		const EventInfo &	event
	)

overridevirtual

Write event start line.

Parameters

[in]	event_label	Numbers of the current event and ensemble.
[in]	event	Event info, see event_info

Reimplemented from smash::OutputInterface.

Definition at line 125 of file icoutput.cc.

                                                      {
   if (event.n_ensembles != 1) {
     throw std::logic_error(
         "ICOutput shouldn't be used with multiple parallel ensembles.");
   }
   std::fprintf(file_.get(), "# event %i ensemble %i start\n",
                event_label.event_number, event_label.ensemble_number);
 }

◆ at_eventend()

void smash::ICOutput::at_eventend	(	const Particles &	particles,
		const EventLabel &	event_label,
		const EventInfo &	event
	)

overridevirtual

Write event end line.

Parameters

[in]	particles	Particles at end of event, expected to be empty
[in]	event_label	Numbers of the current event and ensemble.
[in]	event	Event info, see event_info

Reimplemented from smash::OutputInterface.

Definition at line 135 of file icoutput.cc.

                                                    {
   if (event.n_ensembles != 1) {
     throw std::logic_error(
         "ICOutput shouldn't be used with multiple parallel ensembles.");
   }
   std::fprintf(file_.get(), "# event %i ensemble %i end\n",
                event_label.event_number, event_label.ensemble_number);
  
   // 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_intermediate_time()

void smash::ICOutput::at_intermediate_time	(	const Particles &	,
		const std::unique_ptr< Clock > &	,
		const DensityParameters &	,
		const EventLabel &	,
		const EventInfo &
	)

overridevirtual

Unused, but needed since virtually declared in mother class.

Reimplemented from smash::OutputInterface.

Definition at line 155 of file icoutput.cc.

                                                                            {
   // Dummy, but virtual function needs to be declared.
 }

◆ at_interaction()

void smash::ICOutput::at_interaction	(	const Action &	action,
		const double
	)

overridevirtual

Write particle data at the hypersurface crossing point to the IC output.

Parameters

[in] action Details about the action

Reimplemented from smash::OutputInterface.

Definition at line 162 of file icoutput.cc.

                                                                 {
   assert(action.get_type() == ProcessType::HyperSurfaceCrossing);
   assert(action.incoming_particles().size() == 1);
  
   ParticleData particle = action.incoming_particles()[0];
  
   // transverse mass
   const double m_trans =
       std::sqrt(particle.effective_mass() * particle.effective_mass() +
                 particle.momentum()[1] * particle.momentum()[1] +
                 particle.momentum()[2] * particle.momentum()[2]);
   // momentum space rapidity
   const double rapidity =
       0.5 * std::log((particle.momentum()[0] + particle.momentum()[3]) /
                      (particle.momentum()[0] - particle.momentum()[3]));
  
   // Determine if particle is spectator:
   // Fulfilled if particle is initial nucleon, aka has no prior interactions
   bool is_spectator = particle.get_history().collisions_per_particle == 0;
  
   // write particle data excluding spectators
   if (!is_spectator) {
     std::fprintf(file_.get(), "%g %g %g %g %g %g %g %g %s %i %i %i \n",
                  particle.position().tau(), particle.position()[1],
                  particle.position()[2], particle.position().eta(), m_trans,
                  particle.momentum()[1], particle.momentum()[2], rapidity,
                  particle.pdgcode().string().c_str(), particle.type().charge(),
                  particle.type().baryon_number(),
                  particle.type().strangeness());
   }
  
   if (IC_proper_time_ < 0.0) {
     // First particle that is removed, overwrite negative default
     IC_proper_time_ = particle.position().tau();
   } else {
     // Verify that all other particles have the same proper time
     const double next_proper_time = particle.position().tau();
     if (!((next_proper_time - IC_proper_time_) < really_small))
       throw std::runtime_error(
           "Hypersurface proper time changed during evolution.");
   }
 }

Member Data Documentation

◆ file_

RenamingFilePtr smash::ICOutput::file_

private

Pointer to output file.

Definition at line 76 of file icoutput.h.

◆ out_par_

const OutputParameters smash::ICOutput::out_par_

private

Structure that holds all the information about what to printout.

Definition at line 78 of file icoutput.h.

◆ IC_proper_time_

double smash::ICOutput::IC_proper_time_ = -1.0

private

Proper time of the particles removed when extracting initial conditions.

Parameter used for testing purposes only. Used to verify that the initial proper time remains unchanged during the evolution. Determined from the actually removed particles. By construction, tau > 0. Nevertheless it is initialized with a negative number to easily find the first particle that is removed from the evolution in at_interaction().

Definition at line 89 of file icoutput.h.

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

src/include/smash/icoutput.h
src/icoutput.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ICOutput()

◆ ~ICOutput()

Member Function Documentation

◆ at_eventstart()

◆ at_eventend()

◆ at_intermediate_time()

◆ at_interaction()

Member Data Documentation

◆ file_

◆ out_par_

◆ IC_proper_time_