queso-0.52.0
|
This class reads the options for the Monte Carlo sequence generator from an input file. More...
#include <MonteCarloSGOptions.h>
Public Member Functions | |
Constructor/Destructor methods | |
MonteCarloSGOptions (const BaseEnvironment &env, const char *prefix) | |
Constructor: reads options from the input file. More... | |
MonteCarloSGOptions (const BaseEnvironment &env, const char *prefix, const McOptionsValues &alternativeOptionsValues) | |
Constructor: with alternative option values. More... | |
~MonteCarloSGOptions () | |
Destructor. More... | |
I/O methods | |
void | scanOptionsValues () |
It scans the option values from the options input file. More... | |
void | print (std::ostream &os) const |
It prints the option values. More... | |
Public Attributes | |
McOptionsValues | m_ov |
std::string | m_prefix |
Private Member Functions | |
void | defineMyOptions (po::options_description &optionsDesc) const |
Defines the options for the Monte Carlo sequence generator as the default options. More... | |
void | getMyOptionValues (po::options_description &optionsDesc) |
Gets the sequence options. More... | |
Private Attributes | |
const BaseEnvironment & | m_env |
po::options_description * | m_optionsDesc |
std::string | m_option_help |
std::string | m_option_dataOutputFileName |
std::string | m_option_dataOutputAllowedSet |
std::string | m_option_pseq_dataOutputPeriod |
std::string | m_option_pseq_dataOutputFileName |
std::string | m_option_pseq_dataOutputFileType |
std::string | m_option_pseq_dataOutputAllowedSet |
std::string | m_option_qseq_dataInputFileName |
std::string | m_option_qseq_dataInputFileType |
std::string | m_option_qseq_size |
std::string | m_option_qseq_displayPeriod |
std::string | m_option_qseq_measureRunTimes |
std::string | m_option_qseq_dataOutputPeriod |
std::string | m_option_qseq_dataOutputFileName |
std::string | m_option_qseq_dataOutputFileType |
std::string | m_option_qseq_dataOutputAllowedSet |
This class reads the options for the Monte Carlo sequence generator from an input file.
Monte Carlo sequence generator expects options for its methods. This class reads the options for the Monte Carlo sequence generator from an input file provided by the user. The class expects the prefix '<prefix>_mc_'. For instance, if 'prefix' is 'foo_775_fp_', then the constructor will read all options that begin with 'foo_775_fp_mc_'.
Definition at line 141 of file MonteCarloSGOptions.h.
QUESO::MonteCarloSGOptions::MonteCarloSGOptions | ( | const BaseEnvironment & | env, |
const char * | prefix | ||
) |
Constructor: reads options from the input file.
Definition at line 127 of file MonteCarloSGOptions.C.
References m_env, QUESO::BaseEnvironment::optionsInputFileName(), UQ_FATAL_TEST_MACRO, and QUESO::BaseEnvironment::worldRank().
QUESO::MonteCarloSGOptions::MonteCarloSGOptions | ( | const BaseEnvironment & | env, |
const char * | prefix, | ||
const McOptionsValues & | alternativeOptionsValues | ||
) |
Constructor: with alternative option values.
In this constructor, the input options are given by alternativeOptionsValues
, thus, they are not read from an input file.
Definition at line 171 of file MonteCarloSGOptions.C.
References m_env, m_ov, m_prefix, QUESO::BaseEnvironment::optionsInputFileName(), QUESO::BaseEnvironment::subDisplayFile(), UQ_FATAL_TEST_MACRO, and QUESO::BaseEnvironment::worldRank().
QUESO::MonteCarloSGOptions::~MonteCarloSGOptions | ( | ) |
Destructor.
Definition at line 230 of file MonteCarloSGOptions.C.
References m_optionsDesc.
|
private |
Defines the options for the Monte Carlo sequence generator as the default options.
Definition at line 270 of file MonteCarloSGOptions.C.
References m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, m_option_pseq_dataOutputAllowedSet, m_option_pseq_dataOutputFileName, m_option_pseq_dataOutputFileType, m_option_pseq_dataOutputPeriod, m_option_qseq_dataInputFileName, m_option_qseq_dataInputFileType, m_option_qseq_dataOutputAllowedSet, m_option_qseq_dataOutputFileName, m_option_qseq_dataOutputFileType, m_option_qseq_dataOutputPeriod, m_option_qseq_displayPeriod, m_option_qseq_measureRunTimes, m_option_qseq_size, UQ_MOC_SG_DATA_OUTPUT_ALLOWED_SET_ODV, UQ_MOC_SG_DATA_OUTPUT_FILE_NAME_ODV, UQ_MOC_SG_PSEQ_COMPUTE_STATS_ODV, UQ_MOC_SG_PSEQ_DATA_OUTPUT_ALLOWED_SET_ODV, UQ_MOC_SG_PSEQ_DATA_OUTPUT_FILE_NAME_ODV, UQ_MOC_SG_PSEQ_DATA_OUTPUT_FILE_TYPE_ODV, UQ_MOC_SG_PSEQ_DATA_OUTPUT_PERIOD_ODV, UQ_MOC_SG_QSEQ_COMPUTE_STATS_ODV, UQ_MOC_SG_QSEQ_DATA_INPUT_FILE_NAME_ODV, UQ_MOC_SG_QSEQ_DATA_INPUT_FILE_TYPE_ODV, UQ_MOC_SG_QSEQ_DATA_OUTPUT_ALLOWED_SET_ODV, UQ_MOC_SG_QSEQ_DATA_OUTPUT_FILE_NAME_ODV, UQ_MOC_SG_QSEQ_DATA_OUTPUT_FILE_TYPE_ODV, UQ_MOC_SG_QSEQ_DATA_OUTPUT_PERIOD_ODV, UQ_MOC_SG_QSEQ_DISPLAY_PERIOD_ODV, UQ_MOC_SG_QSEQ_MEASURE_RUN_TIMES_ODV, and UQ_MOC_SG_QSEQ_SIZE_ODV.
Referenced by scanOptionsValues().
|
private |
Gets the sequence options.
Definition at line 301 of file MonteCarloSGOptions.C.
References QUESO::BaseEnvironment::allOptionsMap(), QUESO::McOptionsValues::m_dataOutputAllowedSet, QUESO::McOptionsValues::m_dataOutputFileName, m_env, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, m_option_pseq_dataOutputAllowedSet, m_option_pseq_dataOutputFileName, m_option_pseq_dataOutputFileType, m_option_pseq_dataOutputPeriod, m_option_qseq_dataInputFileName, m_option_qseq_dataInputFileType, m_option_qseq_dataOutputAllowedSet, m_option_qseq_dataOutputFileName, m_option_qseq_dataOutputFileType, m_option_qseq_dataOutputPeriod, m_option_qseq_displayPeriod, m_option_qseq_measureRunTimes, m_option_qseq_size, m_ov, QUESO::McOptionsValues::m_pseqDataOutputAllowedSet, QUESO::McOptionsValues::m_pseqDataOutputFileName, QUESO::McOptionsValues::m_pseqDataOutputFileType, QUESO::McOptionsValues::m_pseqDataOutputPeriod, QUESO::McOptionsValues::m_qseqDataInputFileName, QUESO::McOptionsValues::m_qseqDataInputFileType, QUESO::McOptionsValues::m_qseqDataOutputAllowedSet, QUESO::McOptionsValues::m_qseqDataOutputFileName, QUESO::McOptionsValues::m_qseqDataOutputFileType, QUESO::McOptionsValues::m_qseqDataOutputPeriod, QUESO::McOptionsValues::m_qseqDisplayPeriod, QUESO::McOptionsValues::m_qseqMeasureRunTimes, QUESO::McOptionsValues::m_qseqSize, QUESO::MiscReadDoublesFromString(), and QUESO::BaseEnvironment::subDisplayFile().
Referenced by scanOptionsValues().
void QUESO::MonteCarloSGOptions::print | ( | std::ostream & | os | ) | const |
It prints the option values.
Definition at line 411 of file MonteCarloSGOptions.C.
References QUESO::McOptionsValues::m_dataOutputAllowedSet, QUESO::McOptionsValues::m_dataOutputFileName, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_pseq_dataOutputAllowedSet, m_option_pseq_dataOutputFileName, m_option_pseq_dataOutputFileType, m_option_pseq_dataOutputPeriod, m_option_qseq_dataInputFileName, m_option_qseq_dataInputFileType, m_option_qseq_dataOutputAllowedSet, m_option_qseq_dataOutputFileName, m_option_qseq_dataOutputFileType, m_option_qseq_dataOutputPeriod, m_option_qseq_displayPeriod, m_option_qseq_measureRunTimes, m_option_qseq_size, m_ov, QUESO::McOptionsValues::m_pseqDataOutputAllowedSet, QUESO::McOptionsValues::m_pseqDataOutputFileName, QUESO::McOptionsValues::m_pseqDataOutputFileType, QUESO::McOptionsValues::m_pseqDataOutputPeriod, QUESO::McOptionsValues::m_qseqDataInputFileName, QUESO::McOptionsValues::m_qseqDataInputFileType, QUESO::McOptionsValues::m_qseqDataOutputAllowedSet, QUESO::McOptionsValues::m_qseqDataOutputFileName, QUESO::McOptionsValues::m_qseqDataOutputFileType, QUESO::McOptionsValues::m_qseqDataOutputPeriod, QUESO::McOptionsValues::m_qseqDisplayPeriod, QUESO::McOptionsValues::m_qseqMeasureRunTimes, and QUESO::McOptionsValues::m_qseqSize.
Referenced by QUESO::operator<<().
void QUESO::MonteCarloSGOptions::scanOptionsValues | ( | ) |
It scans the option values from the options input file.
Definition at line 240 of file MonteCarloSGOptions.C.
References defineMyOptions(), getMyOptionValues(), m_env, m_optionsDesc, m_ov, m_prefix, QUESO::BaseEnvironment::scanInputFileForMyOptions(), QUESO::BaseEnvironment::subDisplayFile(), UQ_FATAL_TEST_MACRO, and QUESO::BaseEnvironment::worldRank().
|
private |
Definition at line 182 of file MonteCarloSGOptions.h.
Referenced by getMyOptionValues(), MonteCarloSGOptions(), and scanOptionsValues().
|
private |
Definition at line 187 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 186 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 185 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), and getMyOptionValues().
|
private |
Definition at line 192 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 190 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 191 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 189 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 197 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 198 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 205 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 203 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 204 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 202 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 200 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 201 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 199 of file MonteCarloSGOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 183 of file MonteCarloSGOptions.h.
Referenced by scanOptionsValues(), and ~MonteCarloSGOptions().
McOptionsValues QUESO::MonteCarloSGOptions::m_ov |
Definition at line 168 of file MonteCarloSGOptions.h.
Referenced by getMyOptionValues(), MonteCarloSGOptions(), print(), and scanOptionsValues().
std::string QUESO::MonteCarloSGOptions::m_prefix |
Definition at line 173 of file MonteCarloSGOptions.h.
Referenced by MonteCarloSGOptions(), and scanOptionsValues().