queso-0.53.0
|
This class provides a suite options one can pass to a QUESO environment. More...
#include <EnvironmentOptions.h>
Public Member Functions | |
Constructor/Destructor methods | |
EnvOptionsValues () | |
Default constructor. More... | |
EnvOptionsValues (const BaseEnvironment *env, const char *prefix) | |
EnvOptionsValues (const EnvOptionsValues &src) | |
Copy constructor. More... | |
virtual | ~EnvOptionsValues () |
Destructor. More... | |
Set methods | |
EnvOptionsValues & | operator= (const EnvOptionsValues &rhs) |
Operator for copying the options of an environment. More... | |
Public Attributes | |
std::string | m_prefix |
Attributes | |
If this string is non-empty, print the options object to the output file | |
std::string | m_help |
unsigned int | m_numSubEnvironments |
std::string | m_subDisplayFileName |
Output filename for sub-screen writing. More... | |
bool | m_subDisplayAllowAll |
Allows (or not) all sub-environments to write to output file. More... | |
bool | m_subDisplayAllowInter0 |
Allows (or not) all inter0 nodes to write to output file. More... | |
std::set< unsigned int > | m_subDisplayAllowedSet |
Sub-environments that will write to output. More... | |
unsigned int | m_displayVerbosity |
Verbosity. More... | |
unsigned int | m_syncVerbosity |
Synchronized verbosity. More... | |
unsigned int | m_checkingLevel |
Checking level. More... | |
std::string | m_rngType |
Type of the random number generator. More... | |
int | m_seed |
Seed of the random number generator. More... | |
std::string | m_platformName |
Platform name. More... | |
std::string | m_identifyingString |
Identifying string. More... | |
unsigned int | m_numDebugParams |
Number of debug parameters. Unused? More... | |
std::vector< double > | m_debugParams |
Debug parameters. Unused? More... | |
Private Member Functions | |
void | copy (const EnvOptionsValues &src) |
Makes an exact copy of an existing EnvOptionsValues instance. More... | |
void | checkOptions () |
Sorts out any inter-option conflicts. More... | |
Private Attributes | |
BoostInputOptionsParser * | m_parser |
std::string | m_option_help |
Input file option name for flagging helpful printing output. More... | |
std::string | m_option_numSubEnvironments |
Input file option name for m_numSubEnvironments. More... | |
std::string | m_option_subDisplayFileName |
Input file option name for m_subDisplayFileName. More... | |
std::string | m_option_subDisplayAllowAll |
Input file option name for m_subDisplayAllowAll. More... | |
std::string | m_option_subDisplayAllowInter0 |
Input file option name for m_subDisplayAllowInter0. More... | |
std::string | m_option_subDisplayAllowedSet |
Input file option name for m_subDisplayAllowedSet. More... | |
std::string | m_option_displayVerbosity |
Input file option name for m_displayVerbosity. More... | |
std::string | m_option_syncVerbosity |
Input file option name for m_syncVerbosity. More... | |
std::string | m_option_checkingLevel |
Input file option name for m_checkingLevel. More... | |
std::string | m_option_rngType |
Input file option name for m_rngType. More... | |
std::string | m_option_seed |
Input file option name for m_seed. More... | |
std::string | m_option_platformName |
Input file option name for m_platformName. More... | |
std::string | m_option_identifyingString |
Input file option name for m_identifyingString. More... | |
Friends | |
std::ostream & | operator<< (std::ostream &os, const EnvOptionsValues &obj) |
Print values of the options chosen. More... | |
This class provides a suite options one can pass to a QUESO environment.
QUESO expects the user to provide an input file with environment options for the library variables. If no input file, a collection of default values is assigned to some of the variables. The class EnvOptionsValues is responsible for this task.
Definition at line 78 of file EnvironmentOptions.h.
QUESO::EnvOptionsValues::EnvOptionsValues | ( | ) |
Default constructor.
Definition at line 39 of file EnvironmentOptions.C.
QUESO::EnvOptionsValues::EnvOptionsValues | ( | const BaseEnvironment * | env, |
const char * | prefix | ||
) |
Definition at line 74 of file EnvironmentOptions.C.
References checkOptions(), QUESO::BoostInputOptionsParser::getOption(), m_checkingLevel, m_displayVerbosity, m_help, m_identifyingString, m_numSubEnvironments, m_option_checkingLevel, m_option_displayVerbosity, m_option_help, m_option_identifyingString, m_option_numSubEnvironments, m_option_platformName, m_option_rngType, m_option_seed, m_option_subDisplayAllowAll, m_option_subDisplayAllowedSet, m_option_subDisplayAllowInter0, m_option_subDisplayFileName, m_option_syncVerbosity, m_parser, m_platformName, m_rngType, m_seed, m_subDisplayAllowAll, m_subDisplayAllowedSet, m_subDisplayAllowInter0, m_subDisplayFileName, m_syncVerbosity, QUESO::BoostInputOptionsParser::registerOption(), QUESO::BoostInputOptionsParser::scanInputFile(), UQ_ENV_CHECKING_LEVEL_ODV, UQ_ENV_DISPLAY_VERBOSITY_ODV, UQ_ENV_HELP, UQ_ENV_IDENTIFYING_STRING_ODV, UQ_ENV_NUM_SUB_ENVIRONMENTS_ODV, UQ_ENV_PLATFORM_NAME_ODV, UQ_ENV_RNG_TYPE_ODV, UQ_ENV_SEED_ODV, UQ_ENV_SUB_DISPLAY_ALLOW_ALL_ODV, UQ_ENV_SUB_DISPLAY_ALLOW_INTER0_ODV, UQ_ENV_SUB_DISPLAY_ALLOWED_SET_ODV, UQ_ENV_SUB_DISPLAY_FILE_NAME_ODV, and UQ_ENV_SYNC_VERBOSITY_ODV.
QUESO::EnvOptionsValues::EnvOptionsValues | ( | const EnvOptionsValues & | src | ) |
Copy constructor.
Definition at line 159 of file EnvironmentOptions.C.
References copy().
|
virtual |
Destructor.
Definition at line 165 of file EnvironmentOptions.C.
References m_parser.
|
private |
Sorts out any inter-option conflicts.
Definition at line 144 of file EnvironmentOptions.C.
References m_subDisplayAllowAll, m_subDisplayAllowedSet, and m_subDisplayAllowInter0.
Referenced by EnvOptionsValues().
|
private |
Makes an exact copy of an existing EnvOptionsValues instance.
Definition at line 181 of file EnvironmentOptions.C.
References m_checkingLevel, m_debugParams, m_displayVerbosity, m_identifyingString, m_numDebugParams, m_numSubEnvironments, m_platformName, m_rngType, m_seed, m_subDisplayAllowAll, m_subDisplayAllowedSet, m_subDisplayAllowInter0, m_subDisplayFileName, and m_syncVerbosity.
Referenced by EnvOptionsValues(), and operator=().
EnvOptionsValues & QUESO::EnvOptionsValues::operator= | ( | const EnvOptionsValues & | rhs | ) |
Operator for copying the options of an environment.
Definition at line 174 of file EnvironmentOptions.C.
References copy().
|
friend |
Print values of the options chosen.
Definition at line 201 of file EnvironmentOptions.C.
unsigned int QUESO::EnvOptionsValues::m_checkingLevel |
Checking level.
Definition at line 139 of file EnvironmentOptions.h.
Referenced by QUESO::BaseEnvironment::checkingLevel(), copy(), EnvOptionsValues(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::operator<<(), and QUESO::EnvironmentOptions::print().
std::vector<double> QUESO::EnvOptionsValues::m_debugParams |
Debug parameters. Unused?
Definition at line 163 of file EnvironmentOptions.h.
Referenced by copy().
unsigned int QUESO::EnvOptionsValues::m_displayVerbosity |
Verbosity.
Definition at line 133 of file EnvironmentOptions.h.
Referenced by copy(), QUESO::BaseEnvironment::displayVerbosity(), EnvOptionsValues(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::operator<<(), and QUESO::EnvironmentOptions::print().
std::string QUESO::EnvOptionsValues::m_help |
Definition at line 104 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues(), and QUESO::FullEnvironment::FullEnvironment().
std::string QUESO::EnvOptionsValues::m_identifyingString |
Identifying string.
Definition at line 157 of file EnvironmentOptions.h.
Referenced by copy(), EnvOptionsValues(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::BaseEnvironment::identifyingString(), QUESO::operator<<(), QUESO::EnvironmentOptions::print(), and QUESO::BaseEnvironment::resetIdentifyingString().
unsigned int QUESO::EnvOptionsValues::m_numDebugParams |
Number of debug parameters. Unused?
Definition at line 160 of file EnvironmentOptions.h.
Referenced by copy().
unsigned int QUESO::EnvOptionsValues::m_numSubEnvironments |
Number of sub-environments (chains). Each chain may have multiple processes.
Definition at line 108 of file EnvironmentOptions.h.
Referenced by copy(), EnvOptionsValues(), QUESO::FullEnvironment::FullEnvironment(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::BaseEnvironment::numSubEnvironments(), QUESO::operator<<(), and QUESO::EnvironmentOptions::print().
|
private |
Input file option name for m_checkingLevel.
Definition at line 194 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues(), and QUESO::operator<<().
|
private |
Input file option name for m_displayVerbosity.
Definition at line 188 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues(), and QUESO::operator<<().
|
private |
Input file option name for flagging helpful printing output.
Definition at line 170 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues().
|
private |
Input file option name for m_identifyingString.
Definition at line 206 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues(), and QUESO::operator<<().
|
private |
Input file option name for m_numSubEnvironments.
Definition at line 173 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues(), and QUESO::operator<<().
|
private |
Input file option name for m_platformName.
Definition at line 203 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues(), and QUESO::operator<<().
|
private |
Input file option name for m_rngType.
Definition at line 197 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues(), and QUESO::operator<<().
|
private |
Input file option name for m_seed.
Definition at line 200 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues(), and QUESO::operator<<().
|
private |
Input file option name for m_subDisplayAllowAll.
Definition at line 179 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues(), and QUESO::operator<<().
|
private |
Input file option name for m_subDisplayAllowedSet.
Definition at line 185 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues(), and QUESO::operator<<().
|
private |
Input file option name for m_subDisplayAllowInter0.
Definition at line 182 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues().
|
private |
Input file option name for m_subDisplayFileName.
Definition at line 176 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues(), and QUESO::operator<<().
|
private |
Input file option name for m_syncVerbosity.
Definition at line 191 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues(), and QUESO::operator<<().
|
private |
Definition at line 167 of file EnvironmentOptions.h.
Referenced by EnvOptionsValues(), QUESO::operator<<(), and ~EnvOptionsValues().
std::string QUESO::EnvOptionsValues::m_platformName |
Platform name.
Definition at line 154 of file EnvironmentOptions.h.
Referenced by copy(), EnvOptionsValues(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::operator<<(), QUESO::BaseEnvironment::platformName(), and QUESO::EnvironmentOptions::print().
std::string QUESO::EnvOptionsValues::m_prefix |
Definition at line 100 of file EnvironmentOptions.h.
std::string QUESO::EnvOptionsValues::m_rngType |
Type of the random number generator.
Definition at line 142 of file EnvironmentOptions.h.
Referenced by copy(), EnvOptionsValues(), QUESO::FullEnvironment::FullEnvironment(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::operator<<(), and QUESO::EnvironmentOptions::print().
int QUESO::EnvOptionsValues::m_seed |
Seed of the random number generator.
If env_seed = -z, with z>=1, then each processor sets the seed to value MPI_RANK + z. It is crucial that +env_seed+ takes a {negative} value, otherwise all chain samples are going to be the same.
Definition at line 151 of file EnvironmentOptions.h.
Referenced by copy(), EnvOptionsValues(), QUESO::FullEnvironment::FullEnvironment(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::operator<<(), and QUESO::EnvironmentOptions::print().
bool QUESO::EnvOptionsValues::m_subDisplayAllowAll |
Allows (or not) all sub-environments to write to output file.
If this option is true, m_subDisplayAllowedSet is ignored.
Definition at line 117 of file EnvironmentOptions.h.
Referenced by checkOptions(), copy(), EnvOptionsValues(), QUESO::FullEnvironment::FullEnvironment(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::operator<<(), and QUESO::EnvironmentOptions::print().
std::set<unsigned int> QUESO::EnvOptionsValues::m_subDisplayAllowedSet |
Sub-environments that will write to output.
This option is ignored if either m_subDisplayAllowAll or m_subDisplayAllowInter0 are true.
Definition at line 130 of file EnvironmentOptions.h.
Referenced by checkOptions(), copy(), EnvOptionsValues(), QUESO::FullEnvironment::FullEnvironment(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::operator<<(), and QUESO::EnvironmentOptions::print().
bool QUESO::EnvOptionsValues::m_subDisplayAllowInter0 |
Allows (or not) all inter0 nodes to write to output file.
If this option is true, m_subDisplayAllowedSet is ignored.
Definition at line 123 of file EnvironmentOptions.h.
Referenced by checkOptions(), copy(), EnvOptionsValues(), QUESO::FullEnvironment::FullEnvironment(), and QUESO::EnvironmentOptions::getMyOptionValues().
std::string QUESO::EnvOptionsValues::m_subDisplayFileName |
Output filename for sub-screen writing.
Definition at line 111 of file EnvironmentOptions.h.
Referenced by copy(), EnvOptionsValues(), QUESO::FullEnvironment::FullEnvironment(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::operator<<(), QUESO::EnvironmentOptions::print(), and QUESO::BaseEnvironment::subDisplayFileName().
unsigned int QUESO::EnvOptionsValues::m_syncVerbosity |
Synchronized verbosity.
Definition at line 136 of file EnvironmentOptions.h.
Referenced by copy(), EnvOptionsValues(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::operator<<(), QUESO::EnvironmentOptions::print(), and QUESO::BaseEnvironment::syncVerbosity().