#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 when building SMASH, otherwise ROOT support will be disabled.

This class produces file smash_run.root, which contains a ROOT TTree. TTree contains information about particles during simulation from all SMASH events. 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), pdgid - PDG code of particle, that characterizes its sort, charge - electric charge of the particle, ev - number of event particle encountered in, tcounter - number of output block in a given event, npart - number of particles, impact_b - impact parameter, and empty_event - whether there was no interaction between the projectile and the target.

Here is an example of ROOT macro to read the ROOT output of SMASH:

int rootfile_analysis_example() {
  // open SMASH output file to be read in
  TFile *input_file = TFile::Open("../build/data/0/smash_run.root");
  if (input_file->IsOpen()) {
    printf("Successfully opened file %s\n", input_file->GetName());
  } else {
    printf("Error at opening file %s\n", input_file->GetName());
  }
 
  // Get a tree from file
  TTree *tree = static_cast<TTree*>(input_file->Get("particles"));
 
  // Get number of entries in a tree
  Int_t nentries = tree->GetEntries();
  printf("Number of entries in a tree is %d\n", nentries);
 
  // This draws p_T distribution at initialization
  // tree->Draw("sqrt(px*px + py*py)","tcounter==0");
 
  // This draws 3D momentum space distribution at initialization
  tree->Draw("px:py:pz","tcounter==0");
 
  return 0;
}

For examples of extracting info from .root file see root.cern.ch To view ROOT file use TBrowser:

root -l

new TBrowser

If option write_collisions is set True, then in addition to particles TTree a collision TTree is created. Information about each collision is 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 97 of file rootoutput.h.

Inheritance diagram for smash::RootOutput:

[legend]

Collaboration diagram for smash::RootOutput:

[legend]

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

	~RootOutput ()
	Destructor. More...

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

void	at_eventend (const Particles &particles, const int event_number, double impact_parameter, bool empty_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) 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 ()=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
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 bf::path	filename_
	Filename of output. More...

bf::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...

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

Buffer for filling TTree
See class documentation for definitions.
std::array< double, max_buffer_size_ >	p0
	Property that is written to ROOT output. More...

std::array< double, max_buffer_size_ >	px
	Property that is written to ROOT output. More...

std::array< double, max_buffer_size_ >	py
	Property that is written to ROOT output. More...

std::array< double, max_buffer_size_ >	pz
	Property that is written to ROOT output. More...

std::array< double, max_buffer_size_ >	t
	Property that is written to ROOT output. More...

std::array< double, max_buffer_size_ >	x
	Property that is written to ROOT output. More...

std::array< double, max_buffer_size_ >	y
	Property that is written to ROOT output. More...

std::array< double, max_buffer_size_ >	z
	Property that is written to ROOT output. More...

std::array< double, max_buffer_size_ >	formation_time_
	Property that is written to ROOT output. More...

std::array< double, max_buffer_size_ >	xsec_factor_
	Property that is written to ROOT output. More...

std::array< double, max_buffer_size_ >	time_last_coll_
	Property that is written to ROOT output. More...

std::array< int, max_buffer_size_ >	pdgcode
	Property that is written to ROOT output. More...

std::array< int, max_buffer_size_ >	charge
	Property that is written to ROOT output. More...

std::array< int, max_buffer_size_ >	coll_per_part_
	Property that is written to ROOT output. More...

std::array< int, max_buffer_size_ >	proc_id_origin_
	Property that is written to ROOT output. More...

std::array< int, max_buffer_size_ >	proc_type_origin_
	Property that is written to ROOT output. More...

std::array< int, max_buffer_size_ >	pdg_mother1_
	Property that is written to ROOT output. More...

std::array< int, max_buffer_size_ >	pdg_mother2_
	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	nin
	Property that is written to ROOT output. More...

int	nout
	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...

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_
	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 bf::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 87 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),
       autosave_frequency_(1000),
       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_ =
       make_unique<TFile>(filename_unfinished_.native().c_str(), "NEW");
   init_trees();
 }

Here is the call graph for this function:

◆ ~RootOutput()

smash::RootOutput::~RootOutput ( )

Destructor.

RootOutput destructor.

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

Definition at line 194 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();
   bf::rename(filename_unfinished_, filename_);
 }

Member Function Documentation

◆ at_eventstart()

void smash::RootOutput::at_eventstart	(	const Particles &	particles,
		const int	event_number
	)

overridevirtual

update event number and writes intermediate particles to a tree.

Parameters

[in]	particles	Particles to be written to output.
[in]	event_number	event number to be used in ROOT output.

Implements smash::OutputInterface.

Definition at line 201 of file rootoutput.cc.

                                                        {
   // save event number
   current_event_ = event_number;
  
   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_++;
   }
 }

Here is the call graph for this function:

◆ at_eventend()

void smash::RootOutput::at_eventend	(	const Particles &	particles,
		const int	event_number,
		double	impact_parameter,
		bool	empty_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_number	event number to be used in ROOT output.
[in]	impact_parameter	event number to be used in ROOT output. [fm]
[in]	empty_event	Whether there was no interaction between the target and the projectile.

Implements smash::OutputInterface.

Definition at line 225 of file rootoutput.cc.

                                                                         {
   impact_b = impact_parameter;
   empty_event_ = empty_event;
   if (write_particles_ &&
       !(empty_event && particles_only_final_ == OutputOnlyFinal::IfNotEmpty)) {
     particles_to_tree(particles);
   }
   /* 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) {
       logg[LHyperSurfaceCrossing].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:

◆ at_intermediate_time()

void smash::RootOutput::at_intermediate_time	(	const Particles &	particles,
		const std::unique_ptr< Clock > &	clock,
		const DensityParameters &	dens_param
	)

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.

Reimplemented from smash::OutputInterface.

Definition at line 216 of file rootoutput.cc.

                                                                  {
   if (write_particles_ && particles_only_final_ == OutputOnlyFinal::No) {
     particles_to_tree(particles);
     output_counter_++;
   }
 }

Here is the call graph for this function:

◆ 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 257 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());
   }
 }

Here is the call graph for this function:

◆ 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 271 of file rootoutput.cc.

                                                {
   int i = 0;
  
   tcounter = output_counter_;
   ev = current_event_;
  
   for (const auto &p : particles) {
     // Buffer full - flush to tree, else fill with particles
     if (i >= max_buffer_size_) {
       npart = max_buffer_size_;
       i = 0;
       particles_tree_->Fill();
     } else {
       t[i] = p.position().x0();
       x[i] = p.position().x1();
       y[i] = p.position().x2();
       z[i] = p.position().x3();
  
       p0[i] = p.momentum().x0();
       px[i] = p.momentum().x1();
       py[i] = p.momentum().x2();
       pz[i] = p.momentum().x3();
  
       pdgcode[i] = p.pdgcode().get_decimal();
       charge[i] = p.type().charge();
  
       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();
       }
  
       i++;
     }
   }
   // Flush rest to tree
   if (i > 0) {
     npart = i;
     particles_tree_->Fill();
   }
 }

Here is the caller graph for this function:

◆ 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 319 of file rootoutput.cc.

                                                                  {
   ev = current_event_;
   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: 10000
    * 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) {
       t[i] = p.position().x0();
       x[i] = p.position().x1();
       y[i] = p.position().x2();
       z[i] = p.position().x3();
  
       p0[i] = p.momentum().x0();
       px[i] = p.momentum().x1();
       py[i] = p.momentum().x2();
       pz[i] = p.momentum().x3();
  
       pdgcode[i] = p.pdgcode().get_decimal();
       charge[i] = p.type().charge();
  
       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();
       }
  
       i++;
     }
   }
  
   collisions_tree_->Fill();
 }

Here is the caller graph for this function:

◆ init_trees()

void smash::RootOutput::init_trees ( )

private

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

Definition at line 107 of file rootoutput.cc.

                             {
   if (write_particles_ || write_initial_conditions_) {
     particles_tree_ = new TTree("particles", "particles");
  
     particles_tree_->Branch("npart", &npart, "npart/I");
     particles_tree_->Branch("impact_b", &impact_b, "impact_b/D");
     particles_tree_->Branch("empty_event", &empty_event_, "empty_event/O");
     particles_tree_->Branch("ev", &ev, "ev/I");
     particles_tree_->Branch("tcounter", &tcounter, "tcounter/I");
  
     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");
  
     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");
     }
   }
  
   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("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");
     }
   }
 }

Here is the caller graph for this function:

Member Data Documentation

◆ filename_

const bf::path smash::RootOutput::filename_

private

Filename of output.

Definition at line 150 of file rootoutput.h.

◆ filename_unfinished_

bf::path smash::RootOutput::filename_unfinished_

private

Filename of output as long as simulation is still running.

Definition at line 152 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 154 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 161 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 168 of file rootoutput.h.

◆ output_counter_

int smash::RootOutput::output_counter_ = 0

private

Number of output in a given event.

Definition at line 186 of file rootoutput.h.

◆ current_event_

int smash::RootOutput::current_event_ = 0

private

Number of current event.

Definition at line 188 of file rootoutput.h.

◆ max_buffer_size_

const int smash::RootOutput::max_buffer_size_ = 10000

staticprivate

Maximal buffer size.

Definition at line 191 of file rootoutput.h.