25 #ifndef UQ_ENVIRONMENT_OPTIONS_H
26 #define UQ_ENVIRONMENT_OPTIONS_H
32 #include <queso/BoostInputOptionsParser.h>
34 #define UQ_ENV_FILENAME_FOR_NO_OUTPUT_FILE "."
35 #define UQ_ENV_FILENAME_FOR_NO_INPUT_FILE "."
37 #define UQ_ENV_HELP ""
38 #define UQ_ENV_NUM_SUB_ENVIRONMENTS_ODV 1
39 #define UQ_ENV_SUB_SCREEN_WRITE_ODV 0
40 #define UQ_ENV_SUB_DISPLAY_FILE_NAME_ODV UQ_ENV_FILENAME_FOR_NO_OUTPUT_FILE
41 #define UQ_ENV_SUB_DISPLAY_ALLOW_ALL_ODV 0
42 #define UQ_ENV_SUB_DISPLAY_ALLOW_INTER0_ODV 0
43 #define UQ_ENV_SUB_DISPLAY_ALLOWED_SET_ODV ""
44 #define UQ_ENV_DISPLAY_VERBOSITY_ODV 0
45 #define UQ_ENV_SYNC_VERBOSITY_ODV 0
46 #define UQ_ENV_CHECKING_LEVEL_ODV 0
47 #define UQ_ENV_RNG_TYPE_ODV "gsl"
48 #define UQ_ENV_SEED_ODV 0
49 #define UQ_ENV_IDENTIFYING_STRING_ODV ""
50 #define UQ_ENV_PLATFORM_NAME_ODV ""
51 #define UQ_ENV_NUM_DEBUG_PARAMS_ODV 0
52 #define UQ_ENV_DEBUG_PARAM_ODV 0.
56 namespace program_options {
57 class options_description;
64 class BaseEnvironment;
215 friend std::ostream&
operator<<(std::ostream& os,
247 void print (std::ostream& os)
const;
256 void defineMyOptions (boost::program_options::options_description& optionsDesc)
const;
259 void getMyOptionValues(boost::program_options::options_description& optionsDesc);
319 #endif // UQ_ENVIRONMENT_CLASS_H
std::string m_option_checkingLevel
Input file option name for m_checkingLevel.
EnvOptionsValues & operator=(const EnvOptionsValues &rhs)
Operator for copying the options of an environment.
bool m_subDisplayAllowAll
Allows (or not) all sub-environments to write to output file.
virtual ~EnvOptionsValues()
Destructor.
BoostInputOptionsParser * m_parser
bool m_subDisplayAllowInter0
Allows (or not) all inter0 nodes to write to output file.
void print(std::ostream &os) const
Print values of the options chosen.
EnvOptionsValues m_ov
Instance of EnvOptionsValues, a class with default values for QUESO environment.
unsigned int m_checkingLevel
Checking level.
std::string m_option_syncVerbosity
Synchronized verbosity.
boost::program_options::options_description * m_optionsDesc
Environment options description.
unsigned int m_numDebugParams
Number of debug parameters. Unused?
std::string m_option_identifyingString
Input file option name for m_identifyingString.
EnvOptionsValues()
Default constructor.
std::string m_option_numSubEnvironments
My number of sub-environments.
void scanOptionsValues()
Scans option values from input file.
std::string m_option_checkingLevel
Checking level.
std::string m_option_displayVerbosity
Input file option name for m_displayVerbosity.
std::string m_option_subDisplayAllowedSet
Input file option name for m_subDisplayAllowedSet.
std::string m_option_identifyingString
Identifying string.
std::string m_option_seed
Input file option name for m_seed.
std::string m_option_subDisplayFileName
My output filename for sub-screen writing.
std::string m_prefix
Options prefix.
std::string m_platformName
Platform name.
std::string m_option_help
Input file option name for flagging helpful printing output.
std::string m_option_subDisplayFileName
Input file option name for m_subDisplayFileName.
const BaseEnvironment & m_env
Environment.
std::set< unsigned int > m_subDisplayAllowedSet
Sub-environments that will write to output.
std::string m_option_subDisplayAllowedSet
Sub-environments that will write to output.
std::ostream & operator<<(std::ostream &os, const BaseEnvironment &obj)
std::string m_option_platformName
Platform name.
std::string m_option_rngType
Type of the random number generator.
std::string m_option_subDisplayAllowAll
Input file option name for m_subDisplayAllowAll.
std::string m_option_seed
Seed of the random number generator.
void checkOptions()
Sorts out any inter-option conflicts.
friend std::ostream & operator<<(std::ostream &os, const EnvOptionsValues &obj)
Print values of the options chosen.
EnvironmentOptions(const BaseEnvironment &env, const char *prefix)
Default constructor.
std::string m_option_subDisplayAllowInter0
Input file option name for m_subDisplayAllowInter0.
void defineMyOptions(boost::program_options::options_description &optionsDesc) const
Define my environment options as the default options.
std::string m_option_subDisplayAllowInter0
Allows (or not) all inter0 nodes to write to output file.
This (virtual) class sets up the environment underlying the use of the QUESO library by an executable...
unsigned int m_numSubEnvironments
std::string m_rngType
Type of the random number generator.
std::string m_option_help
std::string m_identifyingString
Identifying string.
std::string m_option_syncVerbosity
Input file option name for m_syncVerbosity.
~EnvironmentOptions()
Destructor.
void copy(const EnvOptionsValues &src)
Makes an exact copy of an existing EnvOptionsValues instance.
This class provides a suite options one can pass to a QUESO environment.
std::string m_option_numSubEnvironments
Input file option name for m_numSubEnvironments.
unsigned int m_displayVerbosity
Verbosity.
void getMyOptionValues(boost::program_options::options_description &optionsDesc)
Gets the option values of the environment.
std::string m_subDisplayFileName
Output filename for sub-screen writing.
std::string m_option_rngType
Input file option name for m_rngType.
int m_seed
Seed of the random number generator.
std::string m_option_platformName
Input file option name for m_platformName.
std::vector< double > m_debugParams
Debug parameters. Unused?
unsigned int m_syncVerbosity
Synchronized verbosity.
std::string m_option_displayVerbosity
Verbosity.
std::string m_option_subDisplayAllowAll
Allows (or not) all sub-environments to write to output file.
This class reads options one can pass to a QUESO environment through an input file.