Version: SMASH-3.2
Public Member Functions | Public Attributes | List of all members
smash::OutputParameters Struct Reference

#include <outputparameters.h>

Helper structure for Experiment to hold output options and parameters.

Experiment has one member of this struct.

Definition at line 62 of file outputparameters.h.

Public Member Functions

 OutputParameters ()
 Default constructor, useful for tests. More...
 
 OutputParameters (Configuration conf)
 Constructor from configuration. More...
 

Public Attributes

ThreeVector td_position
 Point, where thermodynamic quantities are calculated. More...
 
DensityType td_dens_type
 Type (e.g., baryon/pion/hadron) of thermodynamic quantity. More...
 
bool td_rho_eckart
 Print out Eckart rest frame density of type td_dens_type or not? More...
 
bool td_tmn
 Print out energy-momentum tensor of type td_dens_type or not? More...
 
bool td_tmn_landau
 Print out energy-momentum tensor in Landau rest frame (of type td_dens_type) or not? More...
 
bool td_v_landau
 Print out Landau velocity of type td_dens_type or not? More...
 
bool td_jQBS
 Print out QBS 4-currents or not? More...
 
bool td_smearing
 Whether smearing is on or off; WARNING : if smearing is off, then final result is in GeV instead of GeV/fm3. More...
 
bool td_only_participants
 Flag reporting whether only participants are considered (true) or also spectators (false) More...
 
bool part_extended
 Extended format for particles output. More...
 
OutputOnlyFinal part_only_final
 Print only final particles in event. More...
 
bool coll_extended
 Extended format for collisions output. More...
 
bool coll_printstartend
 Print initial and final particles in event into collision output. More...
 
bool dil_extended
 Extended format for dilepton output. More...
 
bool photons_extended
 Extended format for photon output. More...
 
bool ic_extended
 Extended initial conditions output. More...
 
RivetOutputParameters rivet_parameters
 Rivet specfic parameters. More...
 
std::map< std::string, std::vector< std::string > > quantities
 Map of quantities to be printed in the output. More...
 

Constructor & Destructor Documentation

◆ OutputParameters() [1/2]

smash::OutputParameters::OutputParameters ( )
inline

Default constructor, useful for tests.

Definition at line 64 of file outputparameters.h.

65  : td_position(ThreeVector()),
66  td_dens_type(DensityType::None),
67  td_rho_eckart(false),
68  td_tmn(false),
69  td_tmn_landau(false),
70  td_v_landau(false),
71  td_jQBS(false),
72  td_smearing(true),
73  td_only_participants(false),
74  part_extended(false),
75  part_only_final(OutputOnlyFinal::Yes),
76  coll_extended(false),
77  coll_printstartend(false),
78  dil_extended(false),
79  photons_extended(false),
80  ic_extended(false),
81  rivet_parameters{},
82  quantities{} {}
OutputOnlyFinal::Yes
@ Yes
Print only final-state particles.
smash::OutputParameters::dil_extended
bool dil_extended
Extended format for dilepton output.
Definition: outputparameters.h:270
smash::OutputParameters::coll_extended
bool coll_extended
Extended format for collisions output.
Definition: outputparameters.h:264
smash::OutputParameters::part_extended
bool part_extended
Extended format for particles output.
Definition: outputparameters.h:258
smash::OutputParameters::photons_extended
bool photons_extended
Extended format for photon output.
Definition: outputparameters.h:273
smash::OutputParameters::td_v_landau
bool td_v_landau
Print out Landau velocity of type td_dens_type or not?
Definition: outputparameters.h:240
smash::OutputParameters::td_tmn_landau
bool td_tmn_landau
Print out energy-momentum tensor in Landau rest frame (of type td_dens_type) or not?
Definition: outputparameters.h:237
smash::OutputParameters::rivet_parameters
RivetOutputParameters rivet_parameters
Rivet specfic parameters.
Definition: outputparameters.h:279
smash::OutputParameters::quantities
std::map< std::string, std::vector< std::string > > quantities
Map of quantities to be printed in the output.
Definition: outputparameters.h:288
smash::OutputParameters::td_jQBS
bool td_jQBS
Print out QBS 4-currents or not?
Definition: outputparameters.h:243
smash::OutputParameters::part_only_final
OutputOnlyFinal part_only_final
Print only final particles in event.
Definition: outputparameters.h:261
smash::OutputParameters::td_dens_type
DensityType td_dens_type
Type (e.g., baryon/pion/hadron) of thermodynamic quantity.
Definition: outputparameters.h:225
smash::OutputParameters::td_tmn
bool td_tmn
Print out energy-momentum tensor of type td_dens_type or not?
Definition: outputparameters.h:231
smash::OutputParameters::td_smearing
bool td_smearing
Whether smearing is on or off; WARNING : if smearing is off, then final result is in GeV instead of G...
Definition: outputparameters.h:249
smash::OutputParameters::td_rho_eckart
bool td_rho_eckart
Print out Eckart rest frame density of type td_dens_type or not?
Definition: outputparameters.h:228
smash::OutputParameters::td_only_participants
bool td_only_participants
Flag reporting whether only participants are considered (true) or also spectators (false)
Definition: outputparameters.h:255
smash::OutputParameters::ic_extended
bool ic_extended
Extended initial conditions output.
Definition: outputparameters.h:276
smash::OutputParameters::td_position
ThreeVector td_position
Point, where thermodynamic quantities are calculated.
Definition: outputparameters.h:222
smash::OutputParameters::coll_printstartend
bool coll_printstartend
Print initial and final particles in event into collision output.
Definition: outputparameters.h:267

◆ OutputParameters() [2/2]

smash::OutputParameters::OutputParameters ( Configuration  conf)
inlineexplicit

Constructor from configuration.

Definition at line 85 of file outputparameters.h.

85  : OutputParameters() {
86  logg[LExperiment].trace(SMASH_SOURCE_LOCATION);
87 
88  if (conf.has_section(InputSections::o_thermodynamics)) {
89  auto thermo_conf = conf.extract_complete_sub_configuration(
90  InputSections::o_thermodynamics);
91  if (thermo_conf.has_value(InputKeys::output_thermodynamics_position)) {
92  const std::array<double, 3> a =
93  thermo_conf.take(InputKeys::output_thermodynamics_position);
94  td_position = ThreeVector(a[0], a[1], a[2]);
95  }
96  std::set<ThermodynamicQuantity> quan =
97  thermo_conf.take(InputKeys::output_thermodynamics_quantites);
98  td_rho_eckart = (quan.count(ThermodynamicQuantity::EckartDensity) > 0);
99  td_tmn = (quan.count(ThermodynamicQuantity::Tmn) > 0);
100  td_tmn_landau = (quan.count(ThermodynamicQuantity::TmnLandau) > 0);
101  td_v_landau = (quan.count(ThermodynamicQuantity::LandauVelocity) > 0);
102  td_jQBS = (quan.count(ThermodynamicQuantity::j_QBS) > 0);
103  td_dens_type = thermo_conf.take(InputKeys::output_thermodynamics_type);
104  if (td_dens_type == DensityType::None &&
105  (td_rho_eckart || td_tmn || td_tmn_landau || td_v_landau)) {
106  logg[LExperiment].warn(
107  "Requested Thermodynamics output with Density type None. ",
108  "Change the density type to avoid output being dropped.");
109  }
110  td_smearing = thermo_conf.take(InputKeys::output_thermodynamics_smearing);
111  td_only_participants =
112  thermo_conf.take(InputKeys::output_thermodynamics_onlyParticipants);
113  }
114 
115  /* Unconditionally take quantities from the configuration file. This is
116  * needed because the 'Format' key in the output content sub-section is
117  * taken before this object is instantiated and that might be the only
118  * present key making the sub-section disappear before the configuration is
119  * handed over to this constructor. As a positive consequence, the
120  * quantities map has always the entry set, at least to an empty list. This
121  * is assumed elsewhere in the code and it ensured here. */
122  const auto part_quantities =
123  conf.take(InputKeys::output_particles_quantities);
124  quantities.insert({"Particles", part_quantities});
125  const auto coll_quantities =
126  conf.take(InputKeys::output_collisions_quantities);
127  quantities.insert({"Collisions", coll_quantities});
128  /* In the same spirit, always take also other particles and collisions keys.
129  * This makes the class behaviour bounded to the key default value and not
130  * to the class member initial value. */
131  part_extended = conf.take(InputKeys::output_particles_extended);
132  part_only_final = conf.take(InputKeys::output_particles_onlyFinal);
133  coll_extended = conf.take(InputKeys::output_collisions_extended);
134  coll_printstartend = conf.take(InputKeys::output_collisions_printStartEnd);
135 
136  if (conf.has_section(InputSections::o_dileptons)) {
137  dil_extended = conf.take(InputKeys::output_dileptons_extended);
138  }
139 
140  if (conf.has_section(InputSections::o_photons)) {
141  photons_extended = conf.take(InputKeys::output_photons_extended);
142  }
143 
144  if (conf.has_section(InputSections::o_initialConditions)) {
145  ic_extended = conf.take(InputKeys::output_initialConditions_extended);
146  }
147 
148  if (conf.has_section(InputSections::o_rivet)) {
149  auto rivet_conf =
150  conf.extract_complete_sub_configuration(InputSections::o_rivet);
151  /*
152  * std::optional<T> can be assigned from a value using the
153  * template<class U = T> optional& operator=( U&& value );
154  * which is a perfect-forwarded assignment. However, in more complex cases
155  * like here where we use a Configuration::Value object returned by
156  * Configuration::take as value, it might be sometimes needed to
157  * explicitly specify the type U. It is then advantageous to use
158  * std::make_optional. When T is a built-in type, an assignment would work
159  * (although not that mentioned above), but std::make_optional also works.
160  * Note that GNU compiler has a buggy implementation of std::make_optional
161  * in versions from 8.1 till 8.3 and hence we use here make_optional and
162  * not std::make_optional. For faulty GNU versions the implementation
163  * shipped within smash namespace is then used, while in all other cases
164  * std::make_optional is used.
165  */
166  if (rivet_conf.has_value(InputKeys::output_rivet_logging)) {
167  rivet_parameters.logs =
168  make_optional<std::map<std::string, std::string>>(
169  rivet_conf.take(InputKeys::output_rivet_logging));
170  }
171  if (rivet_conf.has_value(InputKeys::output_rivet_paths)) {
172  rivet_parameters.paths = make_optional<std::vector<std::string>>(
173  rivet_conf.take(InputKeys::output_rivet_paths));
174  }
175  if (rivet_conf.has_value(InputKeys::output_rivet_preloads)) {
176  rivet_parameters.preloads = make_optional<std::vector<std::string>>(
177  rivet_conf.take(InputKeys::output_rivet_preloads));
178  }
179  if (rivet_conf.has_value(InputKeys::output_rivet_analyses)) {
180  rivet_parameters.analyses = make_optional<std::vector<std::string>>(
181  rivet_conf.take(InputKeys::output_rivet_analyses));
182  }
183  if (rivet_conf.has_value(InputKeys::output_rivet_crossSection)) {
184  rivet_parameters.cross_sections = make_optional<std::array<double, 2>>(
185  rivet_conf.take(InputKeys::output_rivet_crossSection));
186  }
187  rivet_parameters.ignore_beams =
188  rivet_conf.take(InputKeys::output_rivet_ignoreBeams);
189  if (rivet_conf.has_section(InputSections::o_r_weights)) {
190  rivet_parameters.any_weight_parameter_was_given = true;
191  if (rivet_conf.has_value(InputKeys::output_rivet_weights_select)) {
192  rivet_parameters.to_be_enabled_weights =
193  make_optional<std::vector<std::string>>(
194  rivet_conf.take(InputKeys::output_rivet_weights_select));
195  }
196  if (rivet_conf.has_value(InputKeys::output_rivet_weights_deselect)) {
197  rivet_parameters.to_be_disabled_weights =
198  make_optional<std::vector<std::string>>(
199  rivet_conf.take(InputKeys::output_rivet_weights_deselect));
200  }
201  if (rivet_conf.has_value(InputKeys::output_rivet_weights_nominal)) {
202  rivet_parameters.nominal_weight_name = make_optional<std::string>(
203  rivet_conf.take(InputKeys::output_rivet_weights_nominal));
204  }
205  if (rivet_conf.has_value(InputKeys::output_rivet_weights_cap)) {
206  rivet_parameters.cap_on_weights = make_optional<double>(
207  rivet_conf.take(InputKeys::output_rivet_weights_cap));
208  }
209  if (rivet_conf.has_value(InputKeys::output_rivet_weights_nloSmearing)) {
210  rivet_parameters.nlo_smearing = make_optional<double>(
211  rivet_conf.take(InputKeys::output_rivet_weights_nloSmearing));
212  }
213  if (rivet_conf.has_value(InputKeys::output_rivet_weights_noMulti)) {
214  rivet_parameters.no_multi_weight = make_optional<bool>(
215  rivet_conf.take(InputKeys::output_rivet_weights_noMulti));
216  }
217  }
218  }
219  }
ThermodynamicQuantity::EckartDensity
@ EckartDensity
Density in the Eckart frame.
ThermodynamicQuantity::Tmn
@ Tmn
Energy-momentum tensor in lab frame.
ThermodynamicQuantity::LandauVelocity
@ LandauVelocity
Velocity of the Landau rest frame.
ThermodynamicQuantity::j_QBS
@ j_QBS
Electric (Q), baryonic (B) and strange (S) currents.
ThermodynamicQuantity::TmnLandau
@ TmnLandau
Energy-momentum tensor in Landau rest frame.
SMASH_SOURCE_LOCATION
#define SMASH_SOURCE_LOCATION
Hackery that is required to output the location in the source code where the log statement occurs.
Definition: logging.h:153
smash::logg
std::array< einhard::Logger<>, std::tuple_size< LogArea::AreaTuple >::value > logg
An array that stores all pre-configured Logger objects.
Definition: logging.cc:40
smash::LExperiment
static constexpr int LExperiment
Definition: outputparameters.h:23
smash::InputKeys::output_initialConditions_extended
static const Key< bool > output_initialConditions_extended
See user guide description for more information.
Definition: input_keys.h:4867
smash::InputKeys::output_rivet_weights_select
static const Key< std::vector< std::string > > output_rivet_weights_select
See user guide description for more information.
Definition: input_keys.h:5132
smash::InputKeys::output_rivet_weights_noMulti
static const Key< bool > output_rivet_weights_noMulti
See user guide description for more information.
Definition: input_keys.h:5102
smash::InputKeys::output_rivet_weights_nominal
static const Key< std::string > output_rivet_weights_nominal
See user guide description for more information.
Definition: input_keys.h:5117
smash::InputKeys::output_thermodynamics_quantites
static const Key< std::set< ThermodynamicQuantity > > output_thermodynamics_quantites
See user guide description for more information.
Definition: input_keys.h:5221
smash::InputKeys::output_thermodynamics_type
static const Key< DensityType > output_thermodynamics_type
See user guide description for more information.
Definition: input_keys.h:5278
smash::InputKeys::output_rivet_ignoreBeams
static const Key< bool > output_rivet_ignoreBeams
See user guide description for more information.
Definition: input_keys.h:4996
smash::InputKeys::output_rivet_preloads
static const Key< std::vector< std::string > > output_rivet_preloads
See user guide description for more information.
Definition: input_keys.h:5040
smash::InputKeys::output_rivet_weights_cap
static const Key< double > output_rivet_weights_cap
See user guide description for more information.
Definition: input_keys.h:5058
smash::InputKeys::output_particles_extended
static const Key< bool > output_particles_extended
See user guide description for more information.
Definition: input_keys.h:4720
smash::InputKeys::output_thermodynamics_position
static const Key< std::array< double, 3 > > output_thermodynamics_position
See user guide description for more information.
Definition: input_keys.h:5191
smash::InputKeys::output_rivet_paths
static const Key< std::vector< std::string > > output_rivet_paths
See user guide description for more information.
Definition: input_keys.h:5026
smash::InputKeys::output_collisions_extended
static const Key< bool > output_collisions_extended
See user guide description for more information.
Definition: input_keys.h:4776
smash::InputKeys::output_particles_onlyFinal
static const Key< OutputOnlyFinal > output_particles_onlyFinal
See user guide description for more information.
Definition: input_keys.h:4755
smash::InputKeys::output_particles_quantities
static const Key< std::vector< std::string > > output_particles_quantities
See user guide description for more information.
Definition: input_keys.h:4736
smash::InputKeys::output_rivet_analyses
static const Key< std::vector< std::string > > output_rivet_analyses
See user guide description for more information.
Definition: input_keys.h:4967
smash::InputKeys::output_dileptons_extended
static const Key< bool > output_dileptons_extended
See user guide description for more information.
Definition: input_keys.h:4828
smash::InputKeys::output_thermodynamics_onlyParticipants
static const Key< bool > output_thermodynamics_onlyParticipants
See user guide description for more information.
Definition: input_keys.h:5178
smash::InputKeys::output_rivet_crossSection
static const Key< std::array< double, 2 > > output_rivet_crossSection
See user guide description for more information.
Definition: input_keys.h:4980
smash::InputKeys::output_rivet_weights_deselect
static const Key< std::vector< std::string > > output_rivet_weights_deselect
See user guide description for more information.
Definition: input_keys.h:5072
smash::InputKeys::output_collisions_printStartEnd
static const Key< bool > output_collisions_printStartEnd
See user guide description for more information.
Definition: input_keys.h:4810
smash::InputKeys::output_thermodynamics_smearing
static const Key< bool > output_thermodynamics_smearing
See user guide description for more information.
Definition: input_keys.h:5260
smash::InputKeys::output_rivet_logging
static const Key< std::map< std::string, std::string > > output_rivet_logging
See user guide description for more information.
Definition: input_keys.h:5012
smash::InputKeys::output_rivet_weights_nloSmearing
static const Key< double > output_rivet_weights_nloSmearing
See user guide description for more information.
Definition: input_keys.h:5087
smash::InputKeys::output_photons_extended
static const Key< bool > output_photons_extended
See user guide description for more information.
Definition: input_keys.h:4846
smash::InputKeys::output_collisions_quantities
static const Key< std::vector< std::string > > output_collisions_quantities
See user guide description for more information.
Definition: input_keys.h:4794
smash::InputSections::o_rivet
static const Section o_rivet
Subsection for the output Rivet content.
Definition: input_keys.h:156
smash::InputSections::o_r_weights
static const Section o_r_weights
Subsection for the output Rivet weights information.
Definition: input_keys.h:158
smash::InputSections::o_thermodynamics
static const Section o_thermodynamics
Subsection for the output thermodynamics content.
Definition: input_keys.h:160
smash::InputSections::o_dileptons
static const Section o_dileptons
Subsection for the output dileptons content.
Definition: input_keys.h:147
smash::InputSections::o_photons
static const Section o_photons
Subsection for the output photons content.
Definition: input_keys.h:154
smash::InputSections::o_initialConditions
static const Section o_initialConditions
Subsection for the output initial conditions content.
Definition: input_keys.h:149
smash::OutputParameters::OutputParameters
OutputParameters()
Default constructor, useful for tests.
Definition: outputparameters.h:64
smash::RivetOutputParameters::to_be_enabled_weights
std::optional< std::vector< std::string > > to_be_enabled_weights
Weights to be enabled for processing.
Definition: outputparameters.h:39
smash::RivetOutputParameters::nominal_weight_name
std::optional< std::string > nominal_weight_name
Nominal weight name.
Definition: outputparameters.h:45
smash::RivetOutputParameters::logs
std::optional< std::map< std::string, std::string > > logs
Logging in Rivet.
Definition: outputparameters.h:31
smash::RivetOutputParameters::preloads
std::optional< std::vector< std::string > > preloads
Data files to pre-load e.g., for centrality configurations.
Definition: outputparameters.h:35
smash::RivetOutputParameters::paths
std::optional< std::vector< std::string > > paths
Paths to analyses libraries and data.
Definition: outputparameters.h:33
smash::RivetOutputParameters::nlo_smearing
std::optional< double > nlo_smearing
How to smear for NLO calculations.
Definition: outputparameters.h:49
smash::RivetOutputParameters::analyses
std::optional< std::vector< std::string > > analyses
Analyses (including options) to add to run.
Definition: outputparameters.h:37
smash::RivetOutputParameters::ignore_beams
bool ignore_beams
Whether Rivet should ignore beams.
Definition: outputparameters.h:53
smash::RivetOutputParameters::cap_on_weights
std::optional< double > cap_on_weights
Cap (maximum) on weights.
Definition: outputparameters.h:47
smash::RivetOutputParameters::no_multi_weight
std::optional< bool > no_multi_weight
Whether Rivet should not care about multi weights.
Definition: outputparameters.h:51
smash::RivetOutputParameters::to_be_disabled_weights
std::optional< std::vector< std::string > > to_be_disabled_weights
Weights to be disabled for processing.
Definition: outputparameters.h:41
smash::RivetOutputParameters::any_weight_parameter_was_given
bool any_weight_parameter_was_given
Whether any weight parameter was specified.
Definition: outputparameters.h:55
smash::RivetOutputParameters::cross_sections
std::optional< std::array< double, 2 > > cross_sections
Cross sections.
Definition: outputparameters.h:43

Member Data Documentation

◆ td_position

ThreeVector smash::OutputParameters::td_position

Point, where thermodynamic quantities are calculated.

Definition at line 222 of file outputparameters.h.

◆ td_dens_type

DensityType smash::OutputParameters::td_dens_type

Type (e.g., baryon/pion/hadron) of thermodynamic quantity.

Definition at line 225 of file outputparameters.h.

◆ td_rho_eckart

bool smash::OutputParameters::td_rho_eckart

Print out Eckart rest frame density of type td_dens_type or not?

Definition at line 228 of file outputparameters.h.

◆ td_tmn

bool smash::OutputParameters::td_tmn

Print out energy-momentum tensor of type td_dens_type or not?

Definition at line 231 of file outputparameters.h.

◆ td_tmn_landau

bool smash::OutputParameters::td_tmn_landau

Print out energy-momentum tensor in Landau rest frame (of type td_dens_type) or not?

Definition at line 237 of file outputparameters.h.

◆ td_v_landau

bool smash::OutputParameters::td_v_landau

Print out Landau velocity of type td_dens_type or not?

Definition at line 240 of file outputparameters.h.

◆ td_jQBS

bool smash::OutputParameters::td_jQBS

Print out QBS 4-currents or not?

Definition at line 243 of file outputparameters.h.

◆ td_smearing

bool smash::OutputParameters::td_smearing

Whether smearing is on or off; WARNING : if smearing is off, then final result is in GeV instead of GeV/fm3.

Definition at line 249 of file outputparameters.h.

◆ td_only_participants

bool smash::OutputParameters::td_only_participants

Flag reporting whether only participants are considered (true) or also spectators (false)

Definition at line 255 of file outputparameters.h.

◆ part_extended

bool smash::OutputParameters::part_extended

Extended format for particles output.

Definition at line 258 of file outputparameters.h.

◆ part_only_final

OutputOnlyFinal smash::OutputParameters::part_only_final

Print only final particles in event.

Definition at line 261 of file outputparameters.h.

◆ coll_extended

bool smash::OutputParameters::coll_extended

Extended format for collisions output.

Definition at line 264 of file outputparameters.h.

◆ coll_printstartend

bool smash::OutputParameters::coll_printstartend

Print initial and final particles in event into collision output.

Definition at line 267 of file outputparameters.h.

◆ dil_extended

bool smash::OutputParameters::dil_extended

Extended format for dilepton output.

Definition at line 270 of file outputparameters.h.

◆ photons_extended

bool smash::OutputParameters::photons_extended

Extended format for photon output.

Definition at line 273 of file outputparameters.h.

◆ ic_extended

bool smash::OutputParameters::ic_extended

Extended initial conditions output.

Definition at line 276 of file outputparameters.h.

◆ rivet_parameters

RivetOutputParameters smash::OutputParameters::rivet_parameters

Rivet specfic parameters.

Definition at line 279 of file outputparameters.h.

◆ quantities

std::map<std::string, std::vector<std::string> > smash::OutputParameters::quantities

Map of quantities to be printed in the output.

Keys are the different output contents. It is initialised in a way such that it is guaranteed that an entry for every content requested by the user exists. When the user requests the output content without specifying a list of quantities, the corresponding entry in the map will be an empty vector.

Definition at line 288 of file outputparameters.h.

The documentation for this struct was generated from the following file: