queso-0.52.0
|
This class provides options for the Multilevel sequence generator if no input file is available. More...
#include <MLSamplingOptions.h>
Public Member Functions | |
Constructor/Destructor methods | |
MLSamplingOptions (const BaseEnvironment &env, const char *prefix) | |
Default constructor. More... | |
~MLSamplingOptions () | |
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 | |
std::string | m_prefix |
Class prefix. (ml) More... | |
std::string | m_restartInputFileName |
Name of restart input file. More... | |
std::string | m_restartInputFileType |
Type of restart input file. More... | |
unsigned int | m_restartChainSize |
Size of restart chain. More... | |
std::string | m_dataOutputFileName |
Name of generic output file. More... | |
bool | m_dataOutputAllowAll |
subEnvs that will write to generic output file More... | |
std::set< unsigned int > | m_dataOutputAllowedSet |
Private Member Functions | |
void | defineMyOptions (po::options_description &optionsDesc) const |
Defines the options for the Multilevel generator of samples as the default options. More... | |
void | getMyOptionValues (po::options_description &optionsDesc) |
Gets the sequence options defined to the Multilevel algorithm. More... | |
Private Attributes | |
const BaseEnvironment & | m_env |
po::options_description * | m_optionsDesc |
std::string | m_option_help |
std::string | m_option_restartInputFileName |
std::string | m_option_restartInputFileType |
std::string | m_option_restartChainSize |
std::string | m_option_dataOutputFileName |
std::string | m_option_dataOutputAllowAll |
std::string | m_option_dataOutputAllowedSet |
This class provides options for the Multilevel sequence generator if no input file is available.
Multilevel sequence generator expects options for its methods. This class provides default values for such options if no input file is available.
Definition at line 67 of file MLSamplingOptions.h.
QUESO::MLSamplingOptions::MLSamplingOptions | ( | const BaseEnvironment & | env, |
const char * | prefix | ||
) |
Default constructor.
Assigns the default suite of options to the Multilevel sequence generator.
Definition at line 30 of file MLSamplingOptions.C.
QUESO::MLSamplingOptions::~MLSamplingOptions | ( | ) |
Destructor.
Definition at line 65 of file MLSamplingOptions.C.
References m_optionsDesc.
|
private |
Defines the options for the Multilevel generator of samples as the default options.
Definition at line 89 of file MLSamplingOptions.C.
References m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, m_option_restartChainSize, m_option_restartInputFileName, m_option_restartInputFileType, ML_CODE_HAS_NEW_RESTART_CAPABILITY, UQ_ML_SAMPLING_DATA_OUTPUT_ALLOWED_SET_ODV, UQ_ML_SAMPLING_DATA_OUTPUT_FILE_NAME_ODV, UQ_ML_SAMPLING_RESTART_CHAIN_SIZE_ODV, UQ_ML_SAMPLING_RESTART_INPUT_FILE_NAME_ODV, and UQ_ML_SAMPLING_RESTART_INPUT_FILE_TYPE_ODV.
Referenced by scanOptionsValues().
|
private |
Gets the sequence options defined to the Multilevel algorithm.
Definition at line 112 of file MLSamplingOptions.C.
References QUESO::BaseEnvironment::allOptionsMap(), m_dataOutputAllowedSet, m_dataOutputFileName, m_env, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, m_option_restartChainSize, m_option_restartInputFileName, m_option_restartInputFileType, m_restartChainSize, m_restartInputFileName, m_restartInputFileType, QUESO::MiscReadDoublesFromString(), QUESO::BaseEnvironment::subDisplayFile(), UQ_FATAL_TEST_MACRO, and QUESO::BaseEnvironment::worldRank().
Referenced by scanOptionsValues().
void QUESO::MLSamplingOptions::print | ( | std::ostream & | os | ) | const |
It prints the option values.
Definition at line 180 of file MLSamplingOptions.C.
References m_dataOutputAllowedSet, m_dataOutputFileName, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_restartChainSize, m_option_restartInputFileName, m_option_restartInputFileType, m_restartChainSize, m_restartInputFileName, and m_restartInputFileType.
Referenced by QUESO::operator<<().
void QUESO::MLSamplingOptions::scanOptionsValues | ( | ) |
It scans the option values from the options input file.
Definition at line 71 of file MLSamplingOptions.C.
References defineMyOptions(), getMyOptionValues(), m_env, m_optionsDesc, m_prefix, QUESO::BaseEnvironment::scanInputFileForMyOptions(), and QUESO::BaseEnvironment::subDisplayFile().
Referenced by QUESO::MLSampling< P_V, P_M >::MLSampling().
bool QUESO::MLSamplingOptions::m_dataOutputAllowAll |
subEnvs that will write to generic output file
Definition at line 121 of file MLSamplingOptions.h.
std::set<unsigned int> QUESO::MLSamplingOptions::m_dataOutputAllowedSet |
Definition at line 122 of file MLSamplingOptions.h.
Referenced by getMyOptionValues(), and print().
std::string QUESO::MLSamplingOptions::m_dataOutputFileName |
Name of generic output file.
Definition at line 118 of file MLSamplingOptions.h.
Referenced by getMyOptionValues(), and print().
|
private |
Definition at line 131 of file MLSamplingOptions.h.
Referenced by getMyOptionValues(), and scanOptionsValues().
|
private |
Definition at line 147 of file MLSamplingOptions.h.
|
private |
Definition at line 148 of file MLSamplingOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 146 of file MLSamplingOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 134 of file MLSamplingOptions.h.
Referenced by defineMyOptions(), and getMyOptionValues().
|
private |
Definition at line 144 of file MLSamplingOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 142 of file MLSamplingOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 143 of file MLSamplingOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 132 of file MLSamplingOptions.h.
Referenced by scanOptionsValues(), and ~MLSamplingOptions().
std::string QUESO::MLSamplingOptions::m_prefix |
Class prefix. (ml)
Definition at line 90 of file MLSamplingOptions.h.
Referenced by scanOptionsValues().
unsigned int QUESO::MLSamplingOptions::m_restartChainSize |
Size of restart chain.
Definition at line 115 of file MLSamplingOptions.h.
Referenced by getMyOptionValues(), and print().
std::string QUESO::MLSamplingOptions::m_restartInputFileName |
Name of restart input file.
Definition at line 109 of file MLSamplingOptions.h.
Referenced by getMyOptionValues(), and print().
std::string QUESO::MLSamplingOptions::m_restartInputFileType |
Type of restart input file.
Definition at line 112 of file MLSamplingOptions.h.
Referenced by getMyOptionValues(), and print().