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 61 of file outputparameters.h.

Collaboration diagram for smash::OutputParameters:

Public Member Functions
	OutputParameters ()
	Default constructor, useful for tests. More...
	OutputParameters (Configuration conf)
	Constructor from configuration. More...
bool	get_coll_extended (std::string name) const
	Pass correct extended flag to binary collision output constructor. 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...

Constructor & Destructor Documentation

OutputParameters() [1/2]

smash::OutputParameters::OutputParameters ( )

inline

Default constructor, useful for tests.

Definition at line 63 of file outputparameters.h.

      : td_position(ThreeVector()),
        td_dens_type(DensityType::None),
        td_rho_eckart(false),
        td_tmn(false),
        td_tmn_landau(false),
        td_v_landau(false),
        td_jQBS(false),
        td_smearing(true),
        td_only_participants(false),
        part_extended(false),
        part_only_final(OutputOnlyFinal::Yes),
        coll_extended(false),
        coll_printstartend(false),
        dil_extended(false),
        photons_extended(false),
        ic_extended(false),
        rivet_parameters{} {}

OutputParameters() [2/2]

smash::OutputParameters::OutputParameters ( Configuration  conf )

inlineexplicit

Constructor from configuration.

Definition at line 83 of file outputparameters.h.

                                                : OutputParameters() {
    logg[LExperiment].trace(SMASH_SOURCE_LOCATION);
 
    if (conf.has_value({"Thermodynamics"})) {
      auto thermo_conf = conf.extract_sub_configuration({"Thermodynamics"});
      if (thermo_conf.has_value({"Position"})) {
        const std::array<double, 3> a = thermo_conf.take({"Position"});
        td_position = ThreeVector(a[0], a[1], a[2]);
      }
      std::set<ThermodynamicQuantity> quan = thermo_conf.take({"Quantities"});
      td_rho_eckart = (quan.count(ThermodynamicQuantity::EckartDensity) > 0);
      td_tmn = (quan.count(ThermodynamicQuantity::Tmn) > 0);
      td_tmn_landau = (quan.count(ThermodynamicQuantity::TmnLandau) > 0);
      td_v_landau = (quan.count(ThermodynamicQuantity::LandauVelocity) > 0);
      td_jQBS = (quan.count(ThermodynamicQuantity::j_QBS) > 0);
      td_dens_type = thermo_conf.take({"Type"}, DensityType::Baryon);
      if (td_dens_type == DensityType::None &&
          (td_rho_eckart || td_tmn || td_tmn_landau || td_v_landau)) {
        logg[LExperiment].warn(
            "Requested Thermodynamics output with Density type None. ",
            "Change the density type to avoid output being dropped.");
      }
      td_smearing = thermo_conf.take({"Smearing"}, true);
      td_only_participants = thermo_conf.take({"Only_Participants"}, false);
    }
 
    if (conf.has_value({"Particles"})) {
      part_extended = conf.take({"Particles", "Extended"}, false);
      part_only_final =
          conf.take({"Particles", "Only_Final"}, OutputOnlyFinal::Yes);
    }
 
    if (conf.has_value({"Collisions"})) {
      coll_extended = conf.take({"Collisions", "Extended"}, false);
      coll_printstartend = conf.take({"Collisions", "Print_Start_End"}, false);
    }
 
    if (conf.has_value({"Dileptons"})) {
      dil_extended = conf.take({"Dileptons", "Extended"}, false);
    }
 
    if (conf.has_value({"Photons"})) {
      photons_extended = conf.take({"Photons", "Extended"}, false);
    }
 
    if (conf.has_value({"Initial_Conditions"})) {
      ic_extended = conf.take({"Initial_Conditions", "Extended"}, false);
    }
 
    if (conf.has_value({"Rivet"})) {
      auto rivet_conf = conf.extract_sub_configuration({"Rivet"});
      logg[LOutput].debug() << "Reading Rivet section from configuration:\n"
                            << rivet_conf.to_string() << "\n";
 
      /*
       * std::optional<T> can be assigned from a value using the
       *    template<class U = T> optional& operator=( U&& value );
       * which is a perfect-forwarded assignment. However, in more complex cases
       * like here where we use a Configuration::Value object returned by
       * Configuration::take as value, it might be sometimes needed to
       * explicitly specify the type U. It is then advantageous to use
       * std::make_optional. When T is a built-in type, an assignment would work
       * (although not that mentioned above), but std::make_optional also works.
       * Note that GNU compiler has a buggy implementation of std::make_optional
       * in versions from 8.1 till 8.3 and hence we use here make_optional and
       * not std::make_optional. For faulty GNU versions the implementation
       * shipped within smash namespace is then used, while in all other cases
       * std::make_optional is used.
       */
      if (rivet_conf.has_value({"Logging"})) {
        rivet_parameters.logs =
            make_optional<std::map<std::string, std::string>>(
                rivet_conf.take({"Logging"}));
      }
      if (rivet_conf.has_value({"Paths"})) {
        rivet_parameters.paths =
            make_optional<std::vector<std::string>>(rivet_conf.take({"Paths"}));
      }
      if (rivet_conf.has_value({"Preloads"})) {
        rivet_parameters.preloads = make_optional<std::vector<std::string>>(
            rivet_conf.take({"Preloads"}));
      }
      if (rivet_conf.has_value({"Analyses"})) {
        rivet_parameters.analyses = make_optional<std::vector<std::string>>(
            rivet_conf.take({"Analyses"}));
      }
      if (rivet_conf.has_value({"Cross_Section"})) {
        rivet_parameters.cross_sections = make_optional<std::array<double, 2>>(
            rivet_conf.take({"Cross_Section"}));
      }
      rivet_parameters.ignore_beams = rivet_conf.take({"Ignore_Beams"}, true);
      if (rivet_conf.has_value({"Weights"})) {
        rivet_parameters.any_weight_parameter_was_given = true;
        if (rivet_conf.has_value({"Weights", "Select"})) {
          rivet_parameters.to_be_enabled_weights =
              make_optional<std::vector<std::string>>(
                  rivet_conf.take({"Weights", "Select"}));
        }
        if (rivet_conf.has_value({"Weights", "Deselect"})) {
          rivet_parameters.to_be_disabled_weights =
              make_optional<std::vector<std::string>>(
                  rivet_conf.take({"Weights", "Deselect"}));
        }
        if (rivet_conf.has_value({"Weights", "Nominal"})) {
          rivet_parameters.nominal_weight_name = make_optional<std::string>(
              rivet_conf.take({"Weights", "Nominal"}));
        }
        if (rivet_conf.has_value({"Weights", "Cap"})) {
          rivet_parameters.cap_on_weights =
              make_optional<double>(rivet_conf.take({"Weights", "Cap"}));
        }
        if (rivet_conf.has_value({"Weights", "NLO_Smearing"})) {
          rivet_parameters.nlo_smearing = make_optional<double>(
              rivet_conf.take({"Weights", "NLO_Smearing"}));
        }
        if (rivet_conf.has_value({"Weights", "No_Multi"})) {
          rivet_parameters.no_multi_weight =
              make_optional<bool>(rivet_conf.take({"Weights", "No_Multi"}));
        }
      }
      logg[LOutput].debug() << "After processing configuration:\n"
                            << rivet_conf.to_string() << "\n";
    }
  }

Here is the call graph for this function:

Member Function Documentation

get_coll_extended()

bool smash::OutputParameters::get_coll_extended ( std::string  name ) const

inline

Pass correct extended flag to binary collision output constructor.

Parameters

[in]

name

(File)name of the output.

Returns

Extended flag for binary output.

Definition at line 213 of file outputparameters.h.

                                               {
    if (name == "Collisions") {
      return coll_extended;
    } else if (name == "Dileptons") {
      return dil_extended;
    } else if (name == "Photons") {
      return photons_extended;
    } else {
      return false;  // error
    }
  }

Member Data Documentation

td_position

ThreeVector smash::OutputParameters::td_position

Point, where thermodynamic quantities are calculated.

Definition at line 226 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 229 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 232 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 235 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 241 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 244 of file outputparameters.h.

td_jQBS

bool smash::OutputParameters::td_jQBS

Print out QBS 4-currents or not?

Definition at line 247 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 253 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 259 of file outputparameters.h.

part_extended

bool smash::OutputParameters::part_extended

Extended format for particles output.

Definition at line 262 of file outputparameters.h.

part_only_final

OutputOnlyFinal smash::OutputParameters::part_only_final

Print only final particles in event.

Definition at line 265 of file outputparameters.h.

coll_extended

bool smash::OutputParameters::coll_extended

Extended format for collisions output.

Definition at line 268 of file outputparameters.h.

coll_printstartend

bool smash::OutputParameters::coll_printstartend

Print initial and final particles in event into collision output.

Definition at line 271 of file outputparameters.h.

dil_extended

bool smash::OutputParameters::dil_extended

Extended format for dilepton output.

Definition at line 274 of file outputparameters.h.

photons_extended

bool smash::OutputParameters::photons_extended

Extended format for photon output.

Definition at line 277 of file outputparameters.h.

ic_extended

bool smash::OutputParameters::ic_extended

Extended initial conditions output.

Definition at line 280 of file outputparameters.h.

rivet_parameters

RivetOutputParameters smash::OutputParameters::rivet_parameters

Rivet specfic parameters.

Definition at line 283 of file outputparameters.h.

---

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

• src/include/smash/outputparameters.h