LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
art::RandomNumberGenerator::Config Struct Reference

#include "RandomNumberGenerator.h"

Public Types

template<typename T >
using Atom = fhicl::Atom< T >
 
using Name = fhicl::Name
 
using Comment = fhicl::Comment
 

Public Attributes

Atom< std::string > defaultEngineKind
 
Atom< std::string > restoreStateLabel
 
Atom< std::string > saveTo
 
Atom< std::string > restoreFrom {Name{"restoreFrom"}, ""}
 
Atom< bool > debug
 
Atom< unsigned > nPrint
 

Detailed Description

Definition at line 173 of file RandomNumberGenerator.h.

Member Typedef Documentation

template<typename T >
using art::RandomNumberGenerator::Config::Atom = fhicl::Atom<T>

Definition at line 175 of file RandomNumberGenerator.h.

Member Data Documentation

Atom<bool> art::RandomNumberGenerator::Config::debug
Initial value:
{
Name{"debug"},
Comment{"Enable printout of random engine states for debugging."},
false}

Definition at line 216 of file RandomNumberGenerator.h.

Atom<std::string> art::RandomNumberGenerator::Config::defaultEngineKind
Initial value:
{
Name{"defaultEngineKind"},
"The 'defaultEngineKind' parameter can be any of the following:\n\n"
" 'DRand48Engine'\n"
" 'DualRand'\n"
" 'Hurd160Engine'\n"
" 'Hurd288Engine'\n"
" 'HepJamesRandom' (art default)\n"
" 'MixMaxRng' (CLHEP default)\n"
" 'MTwistEngine'\n"
" 'RanecuEngine'\n"
" 'Ranlux64Engine'\n"
" 'RanluxEngine'\n"
" 'RanshiEngine'\n"
" 'TripleRand'\n"},
"HepJamesRandom"}

Definition at line 178 of file RandomNumberGenerator.h.

Atom<unsigned> art::RandomNumberGenerator::Config::nPrint
Initial value:
{
Name{"nPrint"},
"Limit the number of printouts to the specified value.\n"
"This parameter can be specified only if 'debug' above is true."},
[this] { return debug(); },
10u}

Definition at line 220 of file RandomNumberGenerator.h.

Atom<std::string> art::RandomNumberGenerator::Config::restoreFrom {Name{"restoreFrom"}, ""}

Definition at line 215 of file RandomNumberGenerator.h.

Atom<std::string> art::RandomNumberGenerator::Config::restoreStateLabel
Initial value:
{
Name{"restoreStateLabel"},
"The 'restoreStateLabel' parameter specifies the input tag used\n"
"to restore the random number engine states, as stored in the\n"
"data product produced by the RandomNumberSaver module.\n"},
""}

Definition at line 195 of file RandomNumberGenerator.h.

Atom<std::string> art::RandomNumberGenerator::Config::saveTo
Initial value:
{
Name{"saveTo"},
"The 'saveTo' and 'restoreFrom' parameters are filenames\n"
"that indicate where the engine states should be saved-to or\n"
"restored-from, respectively. Engine states are saved at the\n"
"end of an art job. This allows a user to (e.g.) send a Ctrl+C\n"
"signal during debugging, which will then save the engine states\n"
"to the specified file during a graceful shutdown. The user can\n"
"then restore the engine states from the file and rerun the job,\n"
"skipping to the appropriate event, but with the correct random\n"
"engine states."},
""}

Definition at line 202 of file RandomNumberGenerator.h.


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