Version: SMASH-1.7
rootoutput.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (c) 2014-2019
4  * SMASH Team
5  *
6  * GNU General Public License (GPLv3 or later)
7  *
8  */
9 
10 #ifndef SRC_INCLUDE_ROOTOUTPUT_H_
11 #define SRC_INCLUDE_ROOTOUTPUT_H_
12 
13 #include <memory>
14 #include <string>
15 #include <vector>
16 
17 #include <boost/filesystem.hpp>
18 #include "TFile.h"
19 #include "TTree.h"
20 
21 #include "configuration.h"
22 #include "forwarddeclarations.h"
23 #include "outputinterface.h"
24 #include "outputparameters.h"
25 
26 namespace smash {
27 class Particles;
28 
97 class RootOutput : public OutputInterface {
98  public:
106  RootOutput(const bf::path &path, const std::string &name,
107  const OutputParameters &out_par);
108 
110  ~RootOutput();
111 
117  void at_eventstart(const Particles &particles,
118  const int event_number) override;
128  void at_eventend(const Particles &particles, const int event_number,
129  double impact_parameter, bool empty_event) override;
137  void at_intermediate_time(const Particles &particles,
138  const std::unique_ptr<Clock> &clock,
139  const DensityParameters &dens_param) override;
146  void at_interaction(const Action &action, const double density) override;
147 
148  private:
150  const bf::path filename_;
154  std::unique_ptr<TFile> root_out_file_;
173  template <typename T>
174  void particles_to_tree(T &particles);
182  void collisions_to_tree(const ParticleList &incoming,
183  const ParticleList &outgoing, const double weight,
184  const double partial_weight);
188  int current_event_ = 0;
189 
191  static const int max_buffer_size_ = 10000;
192 
194  std::array<double, max_buffer_size_> p0, px, py, pz, t, x, y, z,
197  std::array<int, max_buffer_size_> pdgcode, charge, coll_per_part_,
200  double wgt, par_wgt, impact_b;
203 
206 
209 
212 
215 
226 
228  const bool part_extended_;
230  const bool coll_extended_;
232  const bool ic_extended_;
233 
238  void init_trees();
239 };
240 
241 } // namespace smash
242 
243 #endif // SRC_INCLUDE_ROOTOUTPUT_H_
std::array< double, max_buffer_size_ > formation_time_
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:195
const bf::path filename_
Filename of output.
Definition: rootoutput.h:150
bool write_initial_conditions_
Option to write particles tree for initial conditions.
Definition: rootoutput.h:211
A class to pre-calculate and store parameters relevant for density calculation.
Definition: density.h:106
int nout
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:199
void particles_to_tree(T &particles)
Writes particles to a tree defined by treename.
Definition: rootoutput.cc:274
bool empty_event_
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:201
int current_event_
Number of current event.
Definition: rootoutput.h:188
std::array< int, max_buffer_size_ > proc_id_origin_
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:197
~RootOutput()
Destructor.
Definition: rootoutput.cc:197
bool write_particles_
Option to write particles tree.
Definition: rootoutput.h:208
std::array< double, max_buffer_size_ > py
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:195
std::unique_ptr< TFile > root_out_file_
Pointer to root output file.
Definition: rootoutput.h:154
void at_eventstart(const Particles &particles, const int event_number) override
update event number and writes intermediate particles to a tree.
Definition: rootoutput.cc:204
std::array< double, max_buffer_size_ > x
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:195
int npart
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:199
std::array< double, max_buffer_size_ > p0
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:195
std::array< double, max_buffer_size_ > time_last_coll_
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:195
TTree * particles_tree_
TTree for particles output.
Definition: rootoutput.h:161
SMASH output to ROOT file SMASH supports ROOT output as an option (see http://root.cern.ch).
Definition: rootoutput.h:97
void init_trees()
Basic initialization routine, creating the TTree objects for particles and collisions.
Definition: rootoutput.cc:106
int nin
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:199
const bool coll_extended_
Whether extended collisions output is on.
Definition: rootoutput.h:230
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.
Definition: rootoutput.cc:322
const bool part_extended_
Whether extended particle output is on.
Definition: rootoutput.h:228
std::array< double, max_buffer_size_ > t
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:195
RootOutput(const bf::path &path, const std::string &name, const OutputParameters &out_par)
Construct ROOT output.
Definition: rootoutput.cc:86
int output_counter_
Number of output in a given event.
Definition: rootoutput.h:186
std::array< double, max_buffer_size_ > z
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:195
std::array< int, max_buffer_size_ > proc_type_origin_
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:197
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 false).
Definition: rootoutput.cc:219
Helper structure for Experiment to hold output options and parameters.
Action is the base class for a generic process that takes a number of incoming particles and transfor...
Definition: action.h:34
std::array< double, max_buffer_size_ > y
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:195
const bool ic_extended_
Whether extended ic output is on.
Definition: rootoutput.h:232
bool write_collisions_
Option to write collisions tree.
Definition: rootoutput.h:205
std::array< double, max_buffer_size_ > px
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:195
double wgt
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:200
bf::path filename_unfinished_
Filename of output as long as simulation is still running.
Definition: rootoutput.h:152
void at_interaction(const Action &action, const double density) override
Writes collisions to a tree defined by treename.
Definition: rootoutput.cc:260
double impact_b
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:200
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.
Definition: rootoutput.cc:228
TTree * collisions_tree_
TTree for collision output.
Definition: rootoutput.h:168
int tcounter
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:199
std::array< double, max_buffer_size_ > xsec_factor_
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:195
bool particles_only_final_
Print only final particles in the event, no intermediate output.
Definition: rootoutput.h:214
std::array< int, max_buffer_size_ > charge
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:197
The Particles class abstracts the storage and manipulation of particles.
Definition: particles.h:33
std::array< int, max_buffer_size_ > pdg_mother1_
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:197
int ev
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:199
std::array< double, max_buffer_size_ > pz
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:195
std::array< int, max_buffer_size_ > pdgcode
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:197
int autosave_frequency_
Root file cannot be read if it was not properly closed and finalized.
Definition: rootoutput.h:225
Abstraction of generic output.
std::array< int, max_buffer_size_ > coll_per_part_
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:197
static const int max_buffer_size_
Maximal buffer size.
Definition: rootoutput.h:191
Definition: action.h:24
std::array< int, max_buffer_size_ > pdg_mother2_
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:197
double par_wgt
Buffer for filling TTree. See class documentation for definitions.
Definition: rootoutput.h:200