Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
mctools::g4::manager_parameters Struct Reference

The set of parameters for the Geant4 simulation manager. More...

#include <bayeux/mctools/g4/manager_parameters.h>

Public Member Functions

 manager_parameters ()
 Default constructor. More...
 
void set_defaults ()
 Set default values. More...
 
void reset ()
 Reset. More...
 
void tree_dump (std::ostream &out_, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
 Smart dump. More...
 

Static Public Member Functions

static void setup (const manager_parameters &a_params, manager &a_manager)
 Setup a simulation manager from a set of parameters. More...
 

Public Attributes

bool interactive = false
 Flag to activate the interactive mode. More...
 
std::string g4_macro
 Name of a Geant4 macro to be executed. More...
 
bool g4_visu = false
 Flag to activate Geant4 visulization. More...
 
std::string logging
 Logging priority threshold label. More...
 
std::vector< std::string > dlls
 List of DLLs to be loaded. More...
 
std::string dll_loader_config
 Configuration file of the DLL loader. More...
 
std::string manager_config_filename
 Main manager configuration file. More...
 
uint32_t number_of_events
 Number of simulated event. More...
 
uint32_t number_of_events_modulo
 Number of events modulo. More...
 
int mgr_seed
 Seed for the Geant4 engine's PRNG. More...
 
std::string input_prng_states_file
 Input file for PRNG's states. More...
 
std::string output_prng_states_file
 Output file for PRNG's states. More...
 
int prng_states_save_modulo
 Period saving the PRNG's internal states. More...
 
std::string input_prng_seeds_file
 Input file for PRNG's seeds. More...
 
std::string init_seed_method
 Method to define the seed initialization. More...
 
std::string output_prng_seeds_file
 Output file for PRNG's seeds. More...
 
std::string output_data_format
 Output data file format. More...
 
std::string output_data_bank_label
 Name of the data bank for the bank output format. More...
 
std::string output_data_file
 Name of the output data file. More...
 
std::string vg_name
 Name of the vertex generator. More...
 
int vg_seed
 Seed for the vertex generator's PRNG. More...
 
std::string eg_name
 Name of the primary event generator. More...
 
int eg_seed
 Seed for the primary event generator's PRNG. More...
 
int shpf_seed
 Seed for the hit post-processing factory. More...
 
bool using_time_stat = false
 Print time statistic at the end of simulation run. More...
 
std::string output_profiles_activation_rule
 The rule to activate Monte Carlo simulation output profiles. More...
 
bool forbid_private_hits = false
 Do not save 'private' MC hits at the end of the simulated event. More...
 
bool dont_save_no_sensitive_hit_events = false
 Do not save 'no sensitive' MC hits. More...
 
bool use_run_header_footer = false
 Add a header/footer in the output data file. More...
 

Detailed Description

The set of parameters for the Geant4 simulation manager.

Constructor & Destructor Documentation

◆ manager_parameters()

mctools::g4::manager_parameters::manager_parameters ( )

Default constructor.

Member Function Documentation

◆ reset()

void mctools::g4::manager_parameters::reset ( )

Reset.

◆ set_defaults()

void mctools::g4::manager_parameters::set_defaults ( )

Set default values.

◆ setup()

static void mctools::g4::manager_parameters::setup ( const manager_parameters a_params,
manager a_manager 
)
static

Setup a simulation manager from a set of parameters.

◆ tree_dump()

void mctools::g4::manager_parameters::tree_dump ( std::ostream &  out_,
const std::string &  title_ = "",
const std::string &  indent_ = "",
bool  inherit_ = false 
) const

Smart dump.

Member Data Documentation

◆ dll_loader_config

std::string mctools::g4::manager_parameters::dll_loader_config

Configuration file of the DLL loader.

◆ dlls

std::vector<std::string> mctools::g4::manager_parameters::dlls

List of DLLs to be loaded.

◆ dont_save_no_sensitive_hit_events

bool mctools::g4::manager_parameters::dont_save_no_sensitive_hit_events = false

Do not save 'no sensitive' MC hits.

◆ eg_name

std::string mctools::g4::manager_parameters::eg_name

Name of the primary event generator.

◆ eg_seed

int mctools::g4::manager_parameters::eg_seed

Seed for the primary event generator's PRNG.

◆ forbid_private_hits

bool mctools::g4::manager_parameters::forbid_private_hits = false

Do not save 'private' MC hits at the end of the simulated event.

◆ g4_macro

std::string mctools::g4::manager_parameters::g4_macro

Name of a Geant4 macro to be executed.

◆ g4_visu

bool mctools::g4::manager_parameters::g4_visu = false

Flag to activate Geant4 visulization.

◆ init_seed_method

std::string mctools::g4::manager_parameters::init_seed_method

Method to define the seed initialization.

◆ input_prng_seeds_file

std::string mctools::g4::manager_parameters::input_prng_seeds_file

Input file for PRNG's seeds.

◆ input_prng_states_file

std::string mctools::g4::manager_parameters::input_prng_states_file

Input file for PRNG's states.

◆ interactive

bool mctools::g4::manager_parameters::interactive = false

Flag to activate the interactive mode.

◆ logging

std::string mctools::g4::manager_parameters::logging

Logging priority threshold label.

◆ manager_config_filename

std::string mctools::g4::manager_parameters::manager_config_filename

Main manager configuration file.

◆ mgr_seed

int mctools::g4::manager_parameters::mgr_seed

Seed for the Geant4 engine's PRNG.

◆ number_of_events

uint32_t mctools::g4::manager_parameters::number_of_events

Number of simulated event.

◆ number_of_events_modulo

uint32_t mctools::g4::manager_parameters::number_of_events_modulo

Number of events modulo.

◆ output_data_bank_label

std::string mctools::g4::manager_parameters::output_data_bank_label

Name of the data bank for the bank output format.

◆ output_data_file

std::string mctools::g4::manager_parameters::output_data_file

Name of the output data file.

◆ output_data_format

std::string mctools::g4::manager_parameters::output_data_format

Output data file format.

◆ output_prng_seeds_file

std::string mctools::g4::manager_parameters::output_prng_seeds_file

Output file for PRNG's seeds.

◆ output_prng_states_file

std::string mctools::g4::manager_parameters::output_prng_states_file

Output file for PRNG's states.

◆ output_profiles_activation_rule

std::string mctools::g4::manager_parameters::output_profiles_activation_rule

The rule to activate Monte Carlo simulation output profiles.

◆ prng_states_save_modulo

int mctools::g4::manager_parameters::prng_states_save_modulo

Period saving the PRNG's internal states.

◆ shpf_seed

int mctools::g4::manager_parameters::shpf_seed

Seed for the hit post-processing factory.

◆ use_run_header_footer

bool mctools::g4::manager_parameters::use_run_header_footer = false

Add a header/footer in the output data file.

◆ using_time_stat

bool mctools::g4::manager_parameters::using_time_stat = false

Print time statistic at the end of simulation run.

◆ vg_name

std::string mctools::g4::manager_parameters::vg_name

Name of the vertex generator.

◆ vg_seed

int mctools::g4::manager_parameters::vg_seed

Seed for the vertex generator's PRNG.


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