#include <rootoutput.h>

\brief SMASH output to ROOT file

SMASH supports ROOT output as an option (see http://root.cern.ch). The ROOT framework needs to be installed before building SMASH, otherwise ROOT support will be disabled.

This class produces file Particles.root, which contains a ROOT TTree. TTree contains information about particles from all SMASH events comprising a simulation. Output is happening in blocks. All particles in a block are at the same time and in the same event. However, it is possible that different blocks are at the same time and from the same event. Particle information is stored in TBranches. For each particle characteristic there is a separate branch. Currently these are t,x,y,z (coordinates), p0,px,py,pz (4-momentum), pdgcode - PDG code of the particle, characterizing its type, charge - electric charge of the particle, ev - event number in a given block, tcounter - number of the output block in a given event, npart - number of particles in the block, test_p - number of testpartciles per particle, modus_l - modus length, current_t - time associated with the output block, in fm, impact_b - impact parameter of the event, empty_event - whether there was no interaction between the projectile and the target, E_kinetic_tot - total kinetic energy in the system, E_fields_tot - total mean field energy * test_p, E_total - sum of E_kinetic_tot and E_fields_tot.

This class also produces file Collisions.root, organized in the same way, with a few additional fields: nin and nout - characterize number of incoming and outgoing particles in the reaction, with nin + nout = npart, weight - an action weight, whose meaning depends on the type of action: For collisions it is the total cross section, for decays it is the total decay width and for dilepton decays it is the shining weight.

If "Collisions:" section is present, then in addition to a file Particles.root with particles TTree, another file Collisions.root is created. It contains information about each collision, written as one leaf: nin, nout - number of incoming and outgoing particles, ev - event number, weight - total weight of the collision (wgt), partial_weight - partial weight of the collision (par_wgt), (t,x,y,z), (p0,px,py,pz) - arrays of dimension nin+nout that contain coordinates and momenta.

Definition at line 78 of file rootoutput.h.

Inheritance diagram for smash::RootOutput:

Public Member Functions
	RootOutput (const std::filesystem::path &path, const std::string &name, const OutputParameters &out_par)
	Construct ROOT output. More...

	~RootOutput ()
	Destructor. More...

void	at_eventstart (const Particles &particles, const EventLabel &event_label, const EventInfo &event) override
	update event number and writes intermediate particles to a tree. More...

void	at_eventend (const Particles &particles, const EventLabel &event_label, const EventInfo &event) override
	update event number and impact parameter, and writes intermediate particles to a tree. More...

void	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 intermediate particles to a tree defined by treename, if it is allowed (i.e., particles_only_final_ is No). More...

void	at_interaction (const Action &action, const double density) override
	Writes collisions to a tree defined by treename. 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 Member Functions
template<typename T >
void	particles_to_tree (T &particles)
	Writes particles to a tree defined by treename. More...

void	collisions_to_tree (const ParticleList &incoming, const ParticleList &outgoing, const double weight, const double partial_weight)
	Writes collisions to a tree defined by treename. More...

Private Attributes
const std::filesystem::path	filename_
	Filename of output. More...

std::filesystem::path	filename_unfinished_
	Filename of output as long as simulation is still running. More...

std::unique_ptr< TFile >	root_out_file_
	Pointer to root output file. More...

TTree *	particles_tree_
	TTree for particles output. More...

TTree *	collisions_tree_
	TTree for collision output. More...

int	output_counter_ = 0
	Number of output in a given event. More...

int	current_event_ = 0
	Number of current event. More...

int	current_ensemble_ = 0
	Number of current ensemble. More...

Static Private Attributes
static const int	max_buffer_size_ = 500000
	Maximal buffer size. More...

Buffer for filling TTree
See class documentation for definitions.
std::vector< double >	p0_ = std::vector<double>(max_buffer_size_, 0.0)
	Property that is written to ROOT output. More...

std::vector< double >	px_ = std::vector<double>(max_buffer_size_, 0.0)
	Property that is written to ROOT output. More...

std::vector< double >	py_ = std::vector<double>(max_buffer_size_, 0.0)
	Property that is written to ROOT output. More...

std::vector< double >	pz_ = std::vector<double>(max_buffer_size_, 0.0)
	Property that is written to ROOT output. More...

std::vector< double >	t_ = std::vector<double>(max_buffer_size_, 0.0)
	Property that is written to ROOT output. More...

std::vector< double >	x_ = std::vector<double>(max_buffer_size_, 0.0)
	Property that is written to ROOT output. More...

std::vector< double >	y_ = std::vector<double>(max_buffer_size_, 0.0)
	Property that is written to ROOT output. More...

std::vector< double >	z_ = std::vector<double>(max_buffer_size_, 0.0)
	Property that is written to ROOT output. More...

std::vector< double >	formation_time_
	Property that is written to ROOT output. More...

std::vector< double >	xsec_factor_ = std::vector<double>(max_buffer_size_, 0.0)
	Property that is written to ROOT output. More...

std::vector< double >	time_last_coll_
	Property that is written to ROOT output. More...

std::vector< int >	pdgcode_ = std::vector<int>(max_buffer_size_, 0)
	Property that is written to ROOT output. More...

std::vector< int >	charge_ = std::vector<int>(max_buffer_size_, 0)
	Property that is written to ROOT output. More...

std::vector< int >	coll_per_part_ = std::vector<int>(max_buffer_size_, 0)
	Property that is written to ROOT output. More...

std::vector< int >	proc_id_origin_ = std::vector<int>(max_buffer_size_, 0)
	Property that is written to ROOT output. More...

std::vector< int >	proc_type_origin_ = std::vector<int>(max_buffer_size_, 0)
	Property that is written to ROOT output. More...

std::vector< int >	pdg_mother1_ = std::vector<int>(max_buffer_size_, 0)
	Property that is written to ROOT output. More...

std::vector< int >	pdg_mother2_ = std::vector<int>(max_buffer_size_, 0)
	Property that is written to ROOT output. More...

std::vector< int >	baryon_number_ = std::vector<int>(max_buffer_size_, 0)
	Property that is written to ROOT output. More...

std::vector< int >	strangeness_ = std::vector<int>(max_buffer_size_, 0)
	Property that is written to ROOT output. More...

int	npart_
	Property that is written to ROOT output. More...

int	tcounter_
	Property that is written to ROOT output. More...

int	ev_
	Property that is written to ROOT output. More...

int	ens_
	Property that is written to ROOT output. More...

int	nin_
	Property that is written to ROOT output. More...

int	nout_
	Property that is written to ROOT output. More...

int	test_p_
	Property that is written to ROOT output. More...

double	wgt_
	Property that is written to ROOT output. More...

double	par_wgt_
	Property that is written to ROOT output. More...

double	impact_b_
	Property that is written to ROOT output. More...

double	modus_l_
	Property that is written to ROOT output. More...

double	current_t_
	Property that is written to ROOT output. More...

double	E_kinetic_tot_
	Property that is written to ROOT output. More...

double	E_fields_tot_
	Property that is written to ROOT output. More...

double	E_tot_
	Property that is written to ROOT output. More...

bool	empty_event_
	Property that is written to ROOT output. More...

bool	write_collisions_
	Option to write collisions tree. More...

bool	write_particles_
	Option to write particles tree. More...

bool	write_initial_conditions_
	Option to write particles tree for initial conditions. More...

OutputOnlyFinal	particles_only_final_
	Print only final particles in the event, no intermediate output. More...

int	autosave_frequency_ = -1
	ROOT file cannot be read if it was not properly closed and finalized. More...

const bool	part_extended_
	Whether extended particle output is on. More...

const bool	coll_extended_
	Whether extended collisions output is on. More...

const bool	ic_extended_
	Whether extended ic output is on. More...

void	init_trees ()
	Basic initialization routine, creating the TTree objects for particles and collisions. 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

◆ RootOutput()

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

Construct ROOT output.

Parameters

[in]	path	Output path.
[in]	name	Name of the ouput.
[in]	out_par	A structure containing parameters of the output.

Definition at line 233 of file rootoutput.cc.

     : OutputInterface(name),
       filename_(path / (name + ".root")),
       write_collisions_(name == "Collisions" || name == "Dileptons" ||
                         name == "Photons"),
       write_particles_(name == "Particles"),
       write_initial_conditions_(name == "SMASH_IC"),
       particles_only_final_(out_par.part_only_final),
       part_extended_(out_par.part_extended),
       coll_extended_(out_par.coll_extended),
       ic_extended_(out_par.ic_extended) {
   filename_unfinished_ = filename_;
   filename_unfinished_ += ".unfinished";
   root_out_file_ =
       std::make_unique<TFile>(filename_unfinished_.native().c_str(), "NEW");
   init_trees();
 }

◆ ~RootOutput()

smash::RootOutput::~RootOutput ( )

Destructor.

RootOutput destructor.

Writes root objects (here TTrees) to file and closes it.

Definition at line 357 of file rootoutput.cc.

                         {
   // kOverwrite option prevents from writing extra TKey objects into root file
   root_out_file_->Write("", TObject::kOverwrite);
   root_out_file_->Close();
   std::filesystem::rename(filename_unfinished_, filename_);
 }

Member Function Documentation

◆ at_eventstart()

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

overridevirtual

update event number and writes intermediate particles to a tree.

Parameters

[in]	particles	Particles to be written to output.
[in]	event_label	Numbers of event and ensemble.
[in]	event	Event info, see event_info

Reimplemented from smash::OutputInterface.

Definition at line 364 of file rootoutput.cc.

                                                        {
   // save event and ensemble numbers
   current_event_ = event_label.event_number;
   current_ensemble_ = event_label.ensemble_number;
  
   modus_l_ = event.modus_length;
   test_p_ = event.test_particles;
   current_t_ = event.current_time;
   E_kinetic_tot_ = event.total_kinetic_energy;
   E_fields_tot_ = event.total_mean_field_energy;
   E_tot_ = event.total_energy;
  
   if (write_particles_ && particles_only_final_ == OutputOnlyFinal::No) {
     output_counter_ = 0;
     // This is to have only one output of positive impact parameter per event
     impact_b_ = -1.0;
     empty_event_ = false;
     particles_to_tree(particles);
     output_counter_++;
   }
 }

◆ at_eventend()

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

overridevirtual

update event number and impact parameter, and writes intermediate particles to a tree.

Parameters

[in]	particles	Particles to be written to output.
[in]	event_label	Numbers of event and ensemble.
[in]	event	Event info, see event_info

Reimplemented from smash::OutputInterface.

Definition at line 407 of file rootoutput.cc.

                                                      {
   current_ensemble_ = event_label.ensemble_number;
   modus_l_ = event.modus_length;
   test_p_ = event.test_particles;
   current_t_ = event.current_time;
   E_kinetic_tot_ = event.total_kinetic_energy;
   E_fields_tot_ = event.total_mean_field_energy;
   E_tot_ = event.total_energy;
  
   impact_b_ = event.impact_parameter;
   empty_event_ = event.empty_event;
   if (write_particles_ &&
       !(event.empty_event &&
         particles_only_final_ == OutputOnlyFinal::IfNotEmpty)) {
     particles_to_tree(particles);
   }
   /* Calculate the autosave frequency to be used. In case multiple ensembles are
    * used this has to be at least 1, so set it to 1 if the number of ensembles
    * is larger than the initial value of the autosave frequency. The evaluation
    * of the actual frequency to be used has to be done only once, i.e. when the
    * autosave_frequency_ has still its meaningless initial negative value. */
   if (autosave_frequency_ < 0) {
     autosave_frequency_ = 1000 / event.n_ensembles;
     if (autosave_frequency_ == 0) {
       autosave_frequency_ = 1;
     }
   }
   /* Forced regular dump from operational memory to disk. Very demanding!
    * If program crashes written data will NOT be lost. */
   if (current_event_ > 0 && current_event_ % autosave_frequency_ == 0) {
     if (write_particles_ || write_initial_conditions_) {
       particles_tree_->AutoSave("SaveSelf");
     }
     if (write_collisions_) {
       collisions_tree_->AutoSave("SaveSelf");
     }
   }
  
   if (write_initial_conditions_) {
     // 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::RootOutput::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 intermediate particles to a tree defined by treename, if it is allowed (i.e., particles_only_final_ is No).

Parameters

[in]	particles	Particles to be written to output.
[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 388 of file rootoutput.cc.

                                                               {
   current_ensemble_ = event_label.ensemble_number;
   modus_l_ = event.modus_length;
   test_p_ = event.test_particles;
   current_t_ = event.current_time;
   E_kinetic_tot_ = event.total_kinetic_energy;
   E_fields_tot_ = event.total_mean_field_energy;
   E_tot_ = event.total_energy;
  
   if (write_particles_ && particles_only_final_ == OutputOnlyFinal::No) {
     particles_to_tree(particles);
     output_counter_++;
   }
 }

◆ at_interaction()

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

overridevirtual

Writes collisions to a tree defined by treename.

Parameters

[in]	action	an Action object containing incoming, outgoing particles and type of interactions.
[in]	density	Unused, needed since inherited.

Reimplemented from smash::OutputInterface.

Definition at line 459 of file rootoutput.cc.

                                                 {
   if (write_collisions_) {
     collisions_to_tree(action.incoming_particles(), action.outgoing_particles(),
                        action.get_total_weight(), action.get_partial_weight());
   }
  
   if (write_initial_conditions_ &&
       action.get_type() == ProcessType::HyperSurfaceCrossing) {
     particles_to_tree(action.incoming_particles());
   }
 }

◆ particles_to_tree()

template<typename T >

void smash::RootOutput::particles_to_tree ( T & particles )

private

Writes particles to a tree defined by treename.

Parameters

[in] particles Particles or ParticleList to be written to output.

Definition at line 473 of file rootoutput.cc.

                                                {
   int i = 0;
  
   ev_ = current_event_;
   ens_ = current_ensemble_;
   tcounter_ = output_counter_;
   bool exceeded_buffer_message = true;
  
   for (const auto &p : particles) {
     // Buffer full - flush to tree, else fill with particles
     if (i >= max_buffer_size_) {
       if (exceeded_buffer_message) {
         logg[LOutput].warn()
             << "\nThe number of particles N = " << particles.size()
             << " exceeds the maximum buffer size B = " << max_buffer_size_
             << ".\nceil(N/B) = "
             << std::ceil(particles.size() /
                          static_cast<double>(max_buffer_size_))
             << " separate ROOT Tree entries will be created at this output."
             << "\nMaximum buffer size (max_buffer_size_) can be changed in "
             << "rootoutput.h\n\n";
         exceeded_buffer_message = false;
       }
       npart_ = max_buffer_size_;
       i = 0;
       particles_tree_->Fill();
     } else {
       pdgcode_[i] = p.pdgcode().get_decimal();
       charge_[i] = p.type().charge();
  
       p0_[i] = p.momentum().x0();
       px_[i] = p.momentum().x1();
       py_[i] = p.momentum().x2();
       pz_[i] = p.momentum().x3();
  
       t_[i] = p.position().x0();
       x_[i] = p.position().x1();
       y_[i] = p.position().x2();
       z_[i] = p.position().x3();
  
       if (part_extended_ || ic_extended_) {
         const auto h = p.get_history();
         formation_time_[i] = p.formation_time();
         xsec_factor_[i] = p.xsec_scaling_factor();
         time_last_coll_[i] = h.time_last_collision;
         coll_per_part_[i] = h.collisions_per_particle;
         proc_id_origin_[i] = h.id_process;
         proc_type_origin_[i] = static_cast<int>(h.process_type);
         pdg_mother1_[i] = h.p1.get_decimal();
         pdg_mother2_[i] = h.p2.get_decimal();
         baryon_number_[i] = p.type().baryon_number();
         strangeness_[i] = p.type().strangeness();
       }
  
       i++;
     }
   }
   // Flush rest to tree
   if (i > 0) {
     npart_ = i;
     particles_tree_->Fill();
   }
 }

◆ collisions_to_tree()

void smash::RootOutput::collisions_to_tree	(	const ParticleList &	incoming,
		const ParticleList &	outgoing,
		const double	weight,
		const double	partial_weight
	)

private

Writes collisions to a tree defined by treename.

Parameters

[in]	incoming	Incoming particles to be written to output.
[in]	outgoing	Outgoing particles to be written to output.
[in]	weight	Total weight of the collision.
[in]	partial_weight	Partial weight of the collision

Definition at line 537 of file rootoutput.cc.

                                                                  {
   ev_ = current_event_;
   ens_ = current_ensemble_;
   nin_ = incoming.size();
   nout_ = outgoing.size();
   npart_ = nin_ + nout_;
   wgt_ = weight;
   par_wgt_ = partial_weight;
  
   int i = 0;
  
   /* It is assumed that nin + nout < max_buffer_size_
    * This is true for any possible reaction for current buffer size
    * But if one wants initial/final particles written to collisions
    * then implementation should be updated. */
  
   for (const ParticleList &plist : {incoming, outgoing}) {
     for (const auto &p : plist) {
       pdgcode_[i] = p.pdgcode().get_decimal();
       charge_[i] = p.type().charge();
  
       p0_[i] = p.momentum().x0();
       px_[i] = p.momentum().x1();
       py_[i] = p.momentum().x2();
       pz_[i] = p.momentum().x3();
  
       t_[i] = p.position().x0();
       x_[i] = p.position().x1();
       y_[i] = p.position().x2();
       z_[i] = p.position().x3();
  
       if (coll_extended_) {
         const auto h = p.get_history();
         formation_time_[i] = p.formation_time();
         xsec_factor_[i] = p.xsec_scaling_factor();
         time_last_coll_[i] = h.time_last_collision;
         coll_per_part_[i] = h.collisions_per_particle;
         proc_id_origin_[i] = h.id_process;
         proc_type_origin_[i] = static_cast<int>(h.process_type);
         pdg_mother1_[i] = h.p1.get_decimal();
         pdg_mother2_[i] = h.p2.get_decimal();
         baryon_number_[i] = p.type().baryon_number();
       }
  
       i++;
     }
   }
  
   collisions_tree_->Fill();
 }

◆ init_trees()

void smash::RootOutput::init_trees ( )

private

Basic initialization routine, creating the TTree objects for particles and collisions.

Definition at line 252 of file rootoutput.cc.

                             {
   if (write_particles_ || write_initial_conditions_) {
     particles_tree_ = new TTree("particles", "particles");
  
     particles_tree_->Branch("ev", &ev_, "ev/I");
     particles_tree_->Branch("ens", &ens_, "ens/I");
     particles_tree_->Branch("tcounter", &tcounter_, "tcounter/I");
     particles_tree_->Branch("npart", &npart_, "npart/I");
     particles_tree_->Branch("test_p", &test_p_, "test_p/I");
     particles_tree_->Branch("modus_l", &modus_l_, "modus_l/D");
     particles_tree_->Branch("current_t", &current_t_, "current_t/D");
     particles_tree_->Branch("impact_b", &impact_b_, "impact_b/D");
     particles_tree_->Branch("empty_event", &empty_event_, "empty_event/O");
  
     particles_tree_->Branch("pdgcode", &pdgcode_[0], "pdgcode[npart]/I");
     particles_tree_->Branch("charge", &charge_[0], "charge[npart]/I");
  
     particles_tree_->Branch("p0", &p0_[0], "p0[npart]/D");
     particles_tree_->Branch("px", &px_[0], "px[npart]/D");
     particles_tree_->Branch("py", &py_[0], "py[npart]/D");
     particles_tree_->Branch("pz", &pz_[0], "pz[npart]/D");
  
     particles_tree_->Branch("t", &t_[0], "t[npart]/D");
     particles_tree_->Branch("x", &x_[0], "x[npart]/D");
     particles_tree_->Branch("y", &y_[0], "y[npart]/D");
     particles_tree_->Branch("z", &z_[0], "z[npart]/D");
  
     particles_tree_->Branch("E_kinetic_tot", &E_kinetic_tot_,
                             "E_kinetic_tot/D");
     particles_tree_->Branch("E_fields_tot", &E_fields_tot_, "E_fields_tot/D");
     particles_tree_->Branch("E_tot", &E_tot_, "E_tot/D");
  
     if (part_extended_ || ic_extended_) {
       particles_tree_->Branch("ncoll", &coll_per_part_[0], "ncoll[npart]/I");
       particles_tree_->Branch("form_time", &formation_time_[0],
                               "form_time[npart]/D");
       particles_tree_->Branch("xsecfac", &xsec_factor_[0], "xsecfac[npart]/D");
       particles_tree_->Branch("proc_id_origin", &proc_id_origin_[0],
                               "proc_id_origin[npart]/I");
       particles_tree_->Branch("proc_type_origin", &proc_type_origin_[0],
                               "proc_type_origin[npart]/I");
       particles_tree_->Branch("time_last_coll", &time_last_coll_[0],
                               "time_last_coll[npart]/D");
       particles_tree_->Branch("pdg_mother1", &pdg_mother1_[0],
                               "pdg_mother1[npart]/I");
       particles_tree_->Branch("pdg_mother2", &pdg_mother2_[0],
                               "pdg_mother2[npart]/I");
       particles_tree_->Branch("baryon_number", &baryon_number_[0],
                               "baryon_number[npart]/I");
       particles_tree_->Branch("strangeness", &strangeness_[0],
                               "strangeness[npart]/I");
     }
   }
  
   if (write_collisions_) {
     collisions_tree_ = new TTree("collisions", "collisions");
  
     collisions_tree_->Branch("nin", &nin_, "nin/I");
     collisions_tree_->Branch("nout", &nout_, "nout/I");
     collisions_tree_->Branch("npart", &npart_, "npart/I");
     collisions_tree_->Branch("ev", &ev_, "ev/I");
     collisions_tree_->Branch("ens", &ens_, "ens/I");
     collisions_tree_->Branch("weight", &wgt_, "weight/D");
     collisions_tree_->Branch("partial_weight", &par_wgt_, "partial_weight/D");
  
     collisions_tree_->Branch("pdgcode", &pdgcode_[0], "pdgcode[npart]/I");
     collisions_tree_->Branch("charge", &charge_[0], "charge[npart]/I");
  
     collisions_tree_->Branch("p0", &p0_[0], "p0[npart]/D");
     collisions_tree_->Branch("px", &px_[0], "px[npart]/D");
     collisions_tree_->Branch("py", &py_[0], "py[npart]/D");
     collisions_tree_->Branch("pz", &pz_[0], "pz[npart]/D");
  
     collisions_tree_->Branch("t", &t_[0], "t[npart]/D");
     collisions_tree_->Branch("x", &x_[0], "x[npart]/D");
     collisions_tree_->Branch("y", &y_[0], "y[npart]/D");
     collisions_tree_->Branch("z", &z_[0], "z[npart]/D");
  
     if (coll_extended_) {
       collisions_tree_->Branch("ncoll", &coll_per_part_[0], "ncoll[npart]/I");
       collisions_tree_->Branch("form_time", &formation_time_[0],
                                "form_time[npart]/D");
       collisions_tree_->Branch("xsecfac", &xsec_factor_[0], "xsecfac[npart]/D");
       collisions_tree_->Branch("proc_id_origin", &proc_id_origin_[0],
                                "proc_id_origin[npart]/I");
       collisions_tree_->Branch("proc_type_origin", &proc_type_origin_[0],
                                "proc_type_origin[npart]/I");
       collisions_tree_->Branch("time_last_coll", &time_last_coll_[0],
                                "time_last_coll[npart]/D");
       collisions_tree_->Branch("pdg_mother1", &pdg_mother1_[0],
                                "pdg_mother1[npart]/I");
       collisions_tree_->Branch("pdg_mother2", &pdg_mother2_[0],
                                "pdg_mother2[npart]/I");
       collisions_tree_->Branch("baryon_number", &baryon_number_[0],
                                "baryon_number[npart]/I");
       collisions_tree_->Branch("strangeness", &strangeness_[0],
                                "strangeness[npart]/I");
     }
   }
 }

Member Data Documentation

◆ filename_

const std::filesystem::path smash::RootOutput::filename_

private

Filename of output.

Definition at line 134 of file rootoutput.h.

◆ filename_unfinished_

std::filesystem::path smash::RootOutput::filename_unfinished_

private

Filename of output as long as simulation is still running.

Definition at line 136 of file rootoutput.h.

◆ root_out_file_

std::unique_ptr<TFile> smash::RootOutput::root_out_file_

private

Pointer to root output file.

Definition at line 138 of file rootoutput.h.

◆ particles_tree_

TTree* smash::RootOutput::particles_tree_

private

TTree for particles output.

TFile takes ownership of all TTrees. That's why TTree is not a unique pointer.

Definition at line 145 of file rootoutput.h.

◆ collisions_tree_

TTree* smash::RootOutput::collisions_tree_

private

TTree for collision output.

TFile takes ownership of all TTrees. That's why TTree is not a unique pointer.

Definition at line 152 of file rootoutput.h.

◆ output_counter_

int smash::RootOutput::output_counter_ = 0

private

Number of output in a given event.

Definition at line 170 of file rootoutput.h.

◆ current_event_

int smash::RootOutput::current_event_ = 0

private

Number of current event.

Definition at line 172 of file rootoutput.h.

◆ current_ensemble_

int smash::RootOutput::current_ensemble_ = 0

private

Number of current ensemble.

Definition at line 174 of file rootoutput.h.

◆ max_buffer_size_

const int smash::RootOutput::max_buffer_size_ = 500000

staticprivate

Maximal buffer size.

When the number of particles N exceeds the buffer size B, data is flushed to the ROOT file every B particles. This creates ceil(N/B) entries in the ROOT Tree at every output.

Definition at line 182 of file rootoutput.h.

◆ p0_

std::vector<double> smash::RootOutput::p0_ = std::vector<double>(max_buffer_size_, 0.0)

private

Property that is written to ROOT output.

Definition at line 189 of file rootoutput.h.

◆ px_

std::vector<double> smash::RootOutput::px_ = std::vector<double>(max_buffer_size_, 0.0)

private

Property that is written to ROOT output.

Definition at line 190 of file rootoutput.h.

◆ py_

std::vector<double> smash::RootOutput::py_ = std::vector<double>(max_buffer_size_, 0.0)

private

Property that is written to ROOT output.

Definition at line 191 of file rootoutput.h.

◆ pz_

std::vector<double> smash::RootOutput::pz_ = std::vector<double>(max_buffer_size_, 0.0)

private

Property that is written to ROOT output.

Definition at line 192 of file rootoutput.h.

◆ t_

std::vector<double> smash::RootOutput::t_ = std::vector<double>(max_buffer_size_, 0.0)

private

Property that is written to ROOT output.

Definition at line 193 of file rootoutput.h.

◆ x_

std::vector<double> smash::RootOutput::x_ = std::vector<double>(max_buffer_size_, 0.0)

private

Property that is written to ROOT output.

Definition at line 194 of file rootoutput.h.

◆ y_

std::vector<double> smash::RootOutput::y_ = std::vector<double>(max_buffer_size_, 0.0)

private

Property that is written to ROOT output.

Definition at line 195 of file rootoutput.h.

◆ z_

std::vector<double> smash::RootOutput::z_ = std::vector<double>(max_buffer_size_, 0.0)

private

Property that is written to ROOT output.

Definition at line 196 of file rootoutput.h.

◆ formation_time_

std::vector<double> smash::RootOutput::formation_time_

private

Initial value:

=

std::vector<double>(max_buffer_size_, 0.0)

Property that is written to ROOT output.

Definition at line 197 of file rootoutput.h.

◆ xsec_factor_

std::vector<double> smash::RootOutput::xsec_factor_ = std::vector<double>(max_buffer_size_, 0.0)

private

Property that is written to ROOT output.

Definition at line 199 of file rootoutput.h.

◆ time_last_coll_

std::vector<double> smash::RootOutput::time_last_coll_

private

Initial value:

=

std::vector<double>(max_buffer_size_, 0.0)

Property that is written to ROOT output.

Definition at line 200 of file rootoutput.h.

◆ pdgcode_

std::vector<int> smash::RootOutput::pdgcode_ = std::vector<int>(max_buffer_size_, 0)

private

Property that is written to ROOT output.

Definition at line 202 of file rootoutput.h.

◆ charge_

std::vector<int> smash::RootOutput::charge_ = std::vector<int>(max_buffer_size_, 0)

private

Property that is written to ROOT output.

Definition at line 203 of file rootoutput.h.

◆ coll_per_part_

std::vector<int> smash::RootOutput::coll_per_part_ = std::vector<int>(max_buffer_size_, 0)

private

Property that is written to ROOT output.

Definition at line 204 of file rootoutput.h.

◆ proc_id_origin_

std::vector<int> smash::RootOutput::proc_id_origin_ = std::vector<int>(max_buffer_size_, 0)

private

Property that is written to ROOT output.

Definition at line 205 of file rootoutput.h.

◆ proc_type_origin_

std::vector<int> smash::RootOutput::proc_type_origin_ = std::vector<int>(max_buffer_size_, 0)

private

Property that is written to ROOT output.

Definition at line 206 of file rootoutput.h.

◆ pdg_mother1_

std::vector<int> smash::RootOutput::pdg_mother1_ = std::vector<int>(max_buffer_size_, 0)

private

Property that is written to ROOT output.

Definition at line 207 of file rootoutput.h.

◆ pdg_mother2_

std::vector<int> smash::RootOutput::pdg_mother2_ = std::vector<int>(max_buffer_size_, 0)

private

Property that is written to ROOT output.

Definition at line 208 of file rootoutput.h.

◆ baryon_number_

std::vector<int> smash::RootOutput::baryon_number_ = std::vector<int>(max_buffer_size_, 0)

private

Property that is written to ROOT output.

Definition at line 209 of file rootoutput.h.

◆ strangeness_

std::vector<int> smash::RootOutput::strangeness_ = std::vector<int>(max_buffer_size_, 0)

private

Property that is written to ROOT output.

Definition at line 210 of file rootoutput.h.

◆ npart_

int smash::RootOutput::npart_

private

Property that is written to ROOT output.

Definition at line 211 of file rootoutput.h.

◆ tcounter_

int smash::RootOutput::tcounter_

private

Property that is written to ROOT output.

Definition at line 211 of file rootoutput.h.

◆ ev_

int smash::RootOutput::ev_

private

Property that is written to ROOT output.

Definition at line 211 of file rootoutput.h.

◆ ens_

int smash::RootOutput::ens_

private

Property that is written to ROOT output.

Definition at line 211 of file rootoutput.h.

◆ nin_

int smash::RootOutput::nin_

private

Property that is written to ROOT output.

Definition at line 211 of file rootoutput.h.

◆ nout_

int smash::RootOutput::nout_

private

Property that is written to ROOT output.

Definition at line 211 of file rootoutput.h.

◆ test_p_

int smash::RootOutput::test_p_

private

Property that is written to ROOT output.

Definition at line 211 of file rootoutput.h.

◆ wgt_

double smash::RootOutput::wgt_

private

Property that is written to ROOT output.

Definition at line 212 of file rootoutput.h.

◆ par_wgt_

double smash::RootOutput::par_wgt_

private

Property that is written to ROOT output.

Definition at line 212 of file rootoutput.h.

◆ impact_b_

double smash::RootOutput::impact_b_

private

Property that is written to ROOT output.

Definition at line 212 of file rootoutput.h.

◆ modus_l_

double smash::RootOutput::modus_l_

private

Property that is written to ROOT output.

Definition at line 212 of file rootoutput.h.

◆ current_t_

double smash::RootOutput::current_t_

private

Property that is written to ROOT output.

Definition at line 212 of file rootoutput.h.

◆ E_kinetic_tot_

double smash::RootOutput::E_kinetic_tot_

private

Property that is written to ROOT output.

Definition at line 213 of file rootoutput.h.

◆ E_fields_tot_

double smash::RootOutput::E_fields_tot_

private

Property that is written to ROOT output.

Definition at line 213 of file rootoutput.h.

◆ E_tot_

double smash::RootOutput::E_tot_

private

Property that is written to ROOT output.

Definition at line 213 of file rootoutput.h.

◆ empty_event_

bool smash::RootOutput::empty_event_

private

Property that is written to ROOT output.

Definition at line 214 of file rootoutput.h.

◆ write_collisions_

bool smash::RootOutput::write_collisions_

private

Option to write collisions tree.

Definition at line 218 of file rootoutput.h.

◆ write_particles_

bool smash::RootOutput::write_particles_

private

Option to write particles tree.

Definition at line 221 of file rootoutput.h.

◆ write_initial_conditions_

bool smash::RootOutput::write_initial_conditions_

private

Option to write particles tree for initial conditions.

Definition at line 224 of file rootoutput.h.

◆ particles_only_final_

OutputOnlyFinal smash::RootOutput::particles_only_final_

private

Print only final particles in the event, no intermediate output.

Definition at line 227 of file rootoutput.h.

◆ autosave_frequency_

int smash::RootOutput::autosave_frequency_ = -1

private

ROOT file cannot be read if it was not properly closed and finalized.

It can happen that SMASH simulation crashed and ROOT file was not closed. To save results of simulation in such case, "AutoSave" is applied every N events. If multiple ensembles are used, N is divided by the number of ensembles per event. This makes sense especially in case of a large number of ensembles and, at the same time, it ensures that all ensembles belonging to the same event are saved. The autosave_frequency_ sets this N (at the moment N=1000 hard-coded). Note that "AutoSave" operation is very time-consuming, so the autosave frequency is always a compromise between safety and speed.

Definition at line 241 of file rootoutput.h.

◆ part_extended_

const bool smash::RootOutput::part_extended_

private

Whether extended particle output is on.

Definition at line 244 of file rootoutput.h.

◆ coll_extended_

const bool smash::RootOutput::coll_extended_

private

Whether extended collisions output is on.

Definition at line 246 of file rootoutput.h.

◆ ic_extended_

const bool smash::RootOutput::ic_extended_

private

Whether extended ic output is on.

Definition at line 248 of file rootoutput.h.

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

src/include/smash/rootoutput.h
src/rootoutput.cc

\brief SMASH output to ROOT file

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Buffer for filling TTree

Additional Inherited Members

Constructor & Destructor Documentation

◆ RootOutput()

◆ ~RootOutput()

Member Function Documentation

◆ at_eventstart()

◆ at_eventend()

◆ at_intermediate_time()

◆ at_interaction()

◆ particles_to_tree()

◆ collisions_to_tree()

◆ init_trees()

Member Data Documentation

◆ filename_

◆ filename_unfinished_

◆ root_out_file_

◆ particles_tree_

◆ collisions_tree_

◆ output_counter_

◆ current_event_

◆ current_ensemble_

◆ max_buffer_size_

◆ p0_

◆ px_

◆ py_

◆ pz_

◆ t_

◆ x_

◆ y_

◆ z_

◆ formation_time_

◆ xsec_factor_

◆ time_last_coll_

◆ pdgcode_

◆ charge_

◆ coll_per_part_

◆ proc_id_origin_

◆ proc_type_origin_

◆ pdg_mother1_

◆ pdg_mother2_

◆ baryon_number_

◆ strangeness_

◆ npart_

◆ tcounter_

◆ ev_

◆ ens_

◆ nin_

◆ nout_

◆ test_p_

◆ wgt_

◆ par_wgt_

◆ impact_b_

◆ modus_l_

◆ current_t_

◆ E_kinetic_tot_

◆ E_fields_tot_

◆ E_tot_

◆ empty_event_

◆ write_collisions_

◆ write_particles_

◆ write_initial_conditions_

◆ particles_only_final_

◆ autosave_frequency_

◆ part_extended_

◆ coll_extended_

◆ ic_extended_