smash::anonymous_namespace{smash.cc} Namespace Reference

Classes
struct	OutputDirectoryExists
	Exception class that is thrown, if the requested output directory already exists and -f was not specified on the command line. More...
struct	OutputDirectoryOutOfIds
	Exception class that is thrown, if no new output path can be generated (there is a directory name for each positive integer value) More...

Functions
void	usage (const int rc, const std::string &progname)
	Prints usage information and exits the program. More...
void	print_disclaimer ()
	Print the disclaimer. More...
std::filesystem::path	default_output_path ()
void	ensure_path_is_valid (const std::filesystem::path &path)
	Ensures the output path is valid. More...
ScatterActionsFinder	actions_finder_for_dump (Configuration &configuration)
	Prepares ActionsFinder for cross-section and reaction dumps. More...
void	check_for_unused_config_values (const Configuration &configuration)
	Checks if there are unused config values. More...
void	ignore_simulation_config_values (Configuration &configuration)
	Remove all config values that are only needed for simulations. More...

Function Documentation

usage()

void smash::anonymous_namespace{smash.cc}::usage	(	const int	rc,
		const std::string &	progname
	)

Prints usage information and exits the program.

Parameters

[out]	rc	Exit status to return
[in]	progname	Name of the program

usage() is called when either the --help or -h command line options are given to the program; in this case, the exit status is EXIT_SUCCESS, or when an unknown option is given; in this case, the exit status is EXIT_FAIL.

Definition at line 139 of file smash.cc.

                                                    {
  std::printf("\nUsage: %s [option]\n\n", progname.c_str());
  std::printf(
      "  -h, --help              usage information\n"
      "\n"
      "  -i, --inputfile <file>  path to input configuration file\n"
      "                          (default: ./config.yaml)\n"
      "  -d, --decaymodes <file> override default decay modes from file\n"
      "  -p, --particles <file>  override default particles from file\n"
      "\n"
      "  -c, --config <YAML>     specify config value overrides\n"
      "                          (multiple -c arguments are supported)\n"
      "  -m, --modus <modus>     shortcut for -c 'General: { Modus: <modus> "
      "}'\n"
      "  -e, --endtime <time>    shortcut for -c 'General: { End_Time: <time> "
      "}'"
      "\n"
      "\n"
      "  -o, --output <dir>      output directory (default: ./data/<runid>)\n"
      "  -l, --list-2-to-n       list all possible 2->n reactions (with n>1)\n"
      "  -r, --resonance <pdg>   dump width(m) and m*spectral function(m^2)"
      " for resonance pdg\n"
      "  -s, --cross-sections    <pdg1>,<pdg2>[,mass1,mass2[,plab1,...]] \n"
      "                          dump all partial cross-sections of "
      "pdg1 + pdg2 reactions versus sqrt(s).\n"
      "  -S, --cross-sections-fs <pdg1>,<pdg2>[,mass1,mass2[,plab1,...]] \n"
      "                          dump an approximation of the final-state"
      " cross-sections\n"
      "                          of pdg1 + pdg2 reactions versus sqrt(s).\n"
      "                          Contributions from strings are not considered"
      " for the final state.\n"
      "                          Masses are optional, by default pole masses"
      " are used.\n"
      "                          Note the required comma and no spaces.\n"
      "  -f, --force             force overwriting files in the output "
      "directory"
      "\n"
      "  -x, --dump_iSS          Dump particle table in iSS format\n"
      "                          This format is used in MUSIC and CLVisc\n"
      "                          relativistic hydro codes\n"
      "  -q, --quiet             Supress disclaimer print-out\n"
      "  -n, --no-cache          Don't cache integrals on disk\n"
      "  -v, --version\n\n");
  std::exit(rc);
}

print_disclaimer()

void smash::anonymous_namespace{smash.cc}::print_disclaimer

(

)

Print the disclaimer.

Definition at line 186 of file smash.cc.

                        {
  std::cout
      << "###################################################################"
      << "############"
      << "\n"
      << "\n"
      << "            :::s.\n"
      << "       ....  ''ss::                                                  "
         "ah:\n"
      << "     a::''.   ..:sss                                                "
         ".HH.\n"
      << "   mss'..     ...s'm.   sSA##As  mAhh##hsh##s.   .hA##ASa  sS###As  "
         "hMAh##h.\n"
      << "  :a':'.      .'':as   sM#'     .HHm''HMS''AMs  mMA' .AMs aMA.     "
         "'HHa..HM:\n"
      << "  .a:s'.    ..''ss     'h#H#S.  mMm  'M#' .HH. 'MH.  :MA  'h#H#S.  "
         "hMm  :M#\n"
      << "   .::ss'.  ....          'SMm .HH.  SMa  hMm  sM#..mHMs     'AMa "
         "'MH.  SMa\n"
      << "      .s::'           #SMASHh  aMS  .MH:  HM:   #MMMmMM. #SMASHh  "
         "aMS  .MM.\n"
      << "\n"
      << "###################################################################"
      << "############"
      << "\n"
      << " This is SMASH version: " << SMASH_VERSION << "\n"
      << " Simulating Many Accelerated Strongly-interacting Hadrons"
      << "\n"
      << "\n"
      << " Distributed under the GNU General Public License 3.0"
      << " (GPLv3 or later)."
      << "\n"
      << " See LICENSE for details."
      << "\n"
      << " For the full list of contributors see the AUTHORS.md file."
      << "\n"
      << "\n"
      << " When using SMASH, please cite"
      << "\n"
      << "      J. Weil et al., Phys.Rev. C94 (2016) no.5, 054905"
      << "\n"
      << " together with the software DOI for the specific code version "
      << "employed:"
      << "\n"
      << "      https://doi.org/10.5281/zenodo.3484711"
      << "\n"
      << " In addition, if Pythia is used please cite"
      << "\n"
      << "      C. Bierlich et al, SciPost Phys. Codebases 8 (2022)"
      << "\n"
      << " together with the Codebase release you used:"
      << "\n"
      << "      https://doi.org/10.21468/SciPostPhysCodeb.8-r8.3"
      << "\n"
      << "\n"
      << " Webpage: https://smash-transport.github.io"
      << "\n"
      << "\n"
      << " Report issues at https://github.com/smash-transport/smash"
      << "\n"
      << " or contact us by email at elfner@itp.uni-frankfurt.de"
      << "\n"
      << "\n"
      << "###################################################################"
      << "############"
      << "\n"
      << "\n";
}

default_output_path()

std::filesystem::path smash::anonymous_namespace{smash.cc}::default_output_path

(

)

Returns

the default path for output.

Definition at line 274 of file smash.cc.

                                        {
  const std::filesystem::path p = std::filesystem::absolute("data");
  if (!std::filesystem::exists(p)) {
    return p / "0";
  }
  std::filesystem::path p2;
  for (int id = 0; id < std::numeric_limits<int>::max(); ++id) {
    p2 = p / std::to_string(id);
    if (!std::filesystem::exists(p2)) {
      break;
    }
  }
  if (p == p2) {
    throw OutputDirectoryOutOfIds("no unique data subdir ID left");
  }
  return p2;
}

ensure_path_is_valid()

void smash::anonymous_namespace{smash.cc}::ensure_path_is_valid

(

const std::filesystem::path &

path

)

Ensures the output path is valid.

Exceptions

OutputDirectoryExists

if the Output directory already exists.

Parameters

[in]

path

The output path to be written to

Definition at line 298 of file smash.cc.

                                                         {
  if (std::filesystem::exists(path)) {
    if (!std::filesystem::is_directory(path)) {
      throw OutputDirectoryExists("The given path (" + path.native() +
                                  ") exists, but it is not a directory.");
    }
  } else {
    if (!std::filesystem::create_directories(path)) {
      throw OutputDirectoryExists(
          "Race condition detected: The directory " + path.native() +
          " did not exist a few cycles ago, but was created in the meantime by "
          "a different process.");
    }
  }
}

actions_finder_for_dump()

ScatterActionsFinder smash::anonymous_namespace{smash.cc}::actions_finder_for_dump

(

Configuration &

configuration

)

Prepares ActionsFinder for cross-section and reaction dumps.

Parameters

[in,out]

configuration

Necessary parameters to switch reactions on/off

Returns

The constructed ScatterActionsFinder .

Definition at line 320 of file smash.cc.

                                                                           {
  ExperimentParameters params = create_experiment_parameters(configuration);
  params.use_monash_tune_default = false;
  return ScatterActionsFinder(configuration, params);
}

check_for_unused_config_values()

void smash::anonymous_namespace{smash.cc}::check_for_unused_config_values

(

const Configuration &

configuration

)

Checks if there are unused config values.

Definition at line 329 of file smash.cc.

                                                                        {
  if (!configuration.is_empty()) {
    throw std::runtime_error(
        "The following configuration values were not used:\n" +
        configuration.to_string());
  }
}

ignore_simulation_config_values()

void smash::anonymous_namespace{smash.cc}::ignore_simulation_config_values

(

Configuration &

configuration

)

Remove all config values that are only needed for simulations.

This is useful when checking for unused config value when SMASH only outputs cross sections, resonance properties or possible reactions.

Definition at line 343 of file smash.cc.

                                                                   {
  for (const std::string s :
       {"particles", "decaymodes", "Modi", "General", "Output", "Lattice",
        "Potentials", "Forced_Thermalization"}) {
    if (configuration.has_value({s.c_str()})) {
      configuration.take({s.c_str()});
    }
  }
}