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 153 of file smash.cc.

                                                    {
  // Implement some tools to format helper using Einhard colors
  const auto colorize = [](const auto &color,
                           const std::string s) -> std::string {
    return color + s + einhard::NoColor_t_::ANSI();
  };
  const auto print_option = [&colorize](
                                const std::string &short_option,
                                const std::string &long_option,
                                std::optional<std::string> value_placeholder,
                                const std::string &description) {
    const auto option_color = std::string{einhard::Cyan_t_::ANSI()};
    const auto value_color = std::string{einhard::DCyan_t_::ANSI()};
    const auto default_color = std::string{einhard::NoColor_t_::ANSI()};
    const int indentation = 2;
    const int effective_option_column_width = 29;
    /* Calculate the width of the option column including the bytes from the
     * ANSI color code which don't appear on screen but are "eaten up" by
     * std::printf and thus must be added here. */
    const int option_column_width =
        effective_option_column_width +
        3 * (option_color.length() + default_color.length());
    const int padding = indentation + effective_option_column_width;
    const int raw_option_length =
        short_option.length() + 2 + long_option.length() +
        ((value_placeholder) ? (1 + value_placeholder->length()) : 0);
    const std::string option{
        colorize(option_color, short_option) + ", " +
        colorize(option_color, long_option) + (value_placeholder ? " " : "") +
        colorize(value_color, value_placeholder.value_or(""))};
    std::printf("%*s%-*s", indentation, "", option_column_width,
                option.c_str());
    bool skip_padding = true;
    if (raw_option_length >= effective_option_column_width) {
      std::printf("\n");
      skip_padding = false;
    }
    for (const auto &line : smash::split(description, '\n')) {
      std::printf("%*s%s\n", (skip_padding) ? 0 : padding, "", line.c_str());
      skip_padding = false;
    }
  };
 
  // Print synopsis
  std::printf(
      "\n Usage: %s\n\n",
      colorize(einhard::Yellow_t_::ANSI(), progname + " [option]").c_str());
 
  // Print options
  print_option("-h", "--help", std::nullopt, "Print usage information");
  print_option("-v", "--version", std::nullopt, "Print version");
  std::printf("\n");
  print_option("-i", "--inputfile", "<file>",
               "Path to input configuration file (default: ./config.yaml)");
  print_option("-o", "--output", "<dir>",
               "Output directory (default: ./data/<runid>)");
  print_option("-f", "--force", std::nullopt,
               "Force overwriting files in the output directory");
  print_option("-d", "--decaymodes", "<file>",
               "Override default decay modes from file");
  print_option("-p", "--particles", "<file>",
               "Override default particles from file");
  print_option("-t", "--tabulations", "<dir>",
               "Tabulations cache directory (default: ./data/tabulations)");
  print_option("-q", "--quiet", std::nullopt, "Suppress disclaimer printout");
  print_option("-n", "--no-cache", std::nullopt,
               "Disable caching integrals on disk");
  std::printf("\n");
  print_option(
      "-c", "--config", "<YAML string>",
      "Specify config value overrides (multiple -c arguments are supported)");
  print_option("-m", "--modus", "<modus>",
               "Shortcut for -c 'General: { Modus: <modus> }'");
  print_option("-e", "--endtime", "<time>",
               "Shortcut for -c 'General: { End_Time: <time> }'");
  std::printf("\n");
  print_option("-l", "--list-2-to-n", std::nullopt,
               "Print list of all possible 2->n reactions (with n>1)");
  print_option("-r", "--resonance", "<pdg>",
               "Print width(m) and m*spectral function(m^2) for resonance pdg");
  print_option(
      "-s", "--cross-sections", "<pdg1>,<pdg2>[,mass1,mass2[,plab1,...]]",
      "Print all partial cross-sections of pdg1 + pdg2 reactions versus "
      "sqrt(s)");
  print_option("-S", "--cross-sections-fs",
               "<pdg1>,<pdg2>[,mass1,mass2[,plab1,...]]",
               "Print an approximation of the final-state cross-sections of "
               "pdg1 + pdg2\nreactions versus sqrt(s). Contributions from "
               "strings are not considered\nfor the final state. Masses are "
               "optional, by default pole masses are used.\nNote the required "
               "comma and no spaces");
  print_option("-x", "--dump_iSS", std::nullopt,
               "Print particles table in iSS format. This format is used in "
               "MUSIC and\nCLVisc relativistic hydro codes");
  std::printf("\n");
  std::exit(rc);
}

Here is the call graph for this function:

Here is the caller graph for this function:

print_disclaimer()

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

(

)

Print the disclaimer.

Definition at line 252 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";
}

Here is the caller graph for this function:

default_output_path()

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

(

)

Returns

the default path for output.

Definition at line 340 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;
}

Here is the call graph for this function:

Here is the caller graph for this function:

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 364 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.");
    }
  }
}

Here is the caller graph for this function:

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 386 of file smash.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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 394 of file smash.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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 408 of file smash.cc.

                                                                   {
  for (const auto &key : {InputKeys::particles, InputKeys::decaymodes}) {
    if (configuration.has_value(key)) {
      configuration.take(key);
    }
  }
  for (const auto &section :
       {InputSections::modi, InputSections::general, InputSections::output,
        InputSections::lattice, InputSections::potentials,
        InputSections::forcedThermalization}) {
    if (configuration.has_section(section)) {
      configuration.extract_sub_configuration(section).clear();
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function: