queso-0.57.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
QUESO::EnvOptionsValues Class Reference

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
EnvOptionsValuesoperator= (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

const BaseEnvironmentm_env
 
ScopedPtr
< BoostInputOptionsParser >
::Type 
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...
 

Detailed Description

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 85 of file EnvironmentOptions.h.

Constructor & Destructor Documentation

QUESO::EnvOptionsValues::EnvOptionsValues ( )

Default constructor.

Definition at line 45 of file EnvironmentOptions.C.

46  :
47  m_prefix("env_"),
48  m_help(UQ_ENV_HELP),
49  m_numSubEnvironments(UQ_ENV_NUM_SUB_ENVIRONMENTS_ODV),
50  m_subDisplayFileName(UQ_ENV_SUB_DISPLAY_FILE_NAME_ODV),
51  m_subDisplayAllowAll(UQ_ENV_SUB_DISPLAY_ALLOW_ALL_ODV),
52  m_subDisplayAllowInter0(UQ_ENV_SUB_DISPLAY_ALLOW_INTER0_ODV),
53  //m_subDisplayAllowedSet (),
54  m_displayVerbosity(UQ_ENV_DISPLAY_VERBOSITY_ODV),
55  m_syncVerbosity(UQ_ENV_SYNC_VERBOSITY_ODV),
56  m_checkingLevel(UQ_ENV_CHECKING_LEVEL_ODV),
57  m_rngType(UQ_ENV_RNG_TYPE_ODV),
58  m_seed(UQ_ENV_SEED_ODV),
59  m_platformName(UQ_ENV_PLATFORM_NAME_ODV),
60  m_identifyingString(UQ_ENV_IDENTIFYING_STRING_ODV),
61  m_numDebugParams(UQ_ENV_NUM_DEBUG_PARAMS_ODV),
63  m_env(NULL),
64 #ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
65  m_parser(),
66 #endif // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
67  m_option_help(m_prefix + "help"),
68  m_option_numSubEnvironments(m_prefix + "numSubEnvironments"),
69  m_option_subDisplayFileName(m_prefix + "subDisplayFileName"),
70  m_option_subDisplayAllowAll(m_prefix + "subDisplayAllowAll"),
71  m_option_subDisplayAllowInter0(m_prefix + "subDisplayAllowInter0"),
72  m_option_subDisplayAllowedSet(m_prefix + "subDisplayAllowedSet"),
73  m_option_displayVerbosity(m_prefix + "displayVerbosity"),
74  m_option_syncVerbosity(m_prefix + "syncVerbosity"),
75  m_option_checkingLevel(m_prefix + "checkingLevel"),
76  m_option_rngType(m_prefix + "rngType"),
77  m_option_seed(m_prefix + "seed"),
78  m_option_platformName(m_prefix + "platformName"),
79  m_option_identifyingString(m_prefix + "identifyingString")
80 {
81 }
std::string m_option_checkingLevel
Input file option name for m_checkingLevel.
bool m_subDisplayAllowAll
Allows (or not) all sub-environments to write to output file.
bool m_subDisplayAllowInter0
Allows (or not) all inter0 nodes to write to output file.
unsigned int m_checkingLevel
Checking level.
unsigned int m_numDebugParams
Number of debug parameters. Unused?
std::string m_option_identifyingString
Input file option name for m_identifyingString.
std::string m_option_displayVerbosity
Input file option name for m_displayVerbosity.
ScopedPtr< BoostInputOptionsParser >::Type m_parser
std::string m_option_subDisplayAllowedSet
Input file option name for m_subDisplayAllowedSet.
std::string m_option_seed
Input file option name for m_seed.
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.
std::string m_option_subDisplayAllowAll
Input file option name for m_subDisplayAllowAll.
std::string m_option_subDisplayAllowInter0
Input file option name for m_subDisplayAllowInter0.
std::string m_rngType
Type of the random number generator.
std::string m_identifyingString
Identifying string.
std::string m_option_syncVerbosity
Input file option name for m_syncVerbosity.
std::string m_option_numSubEnvironments
Input file option name for m_numSubEnvironments.
const BaseEnvironment * m_env
unsigned int m_displayVerbosity
Verbosity.
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.
QUESO::EnvOptionsValues::EnvOptionsValues ( const BaseEnvironment env,
const char *  prefix 
)

Definition at line 83 of file EnvironmentOptions.C.

References checkOptions(), QUESO::BaseEnvironment::input(), m_checkingLevel, m_displayVerbosity, m_env, 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, and QUESO::size.

85  :
86  m_prefix((std::string) + "env_"),
87  m_help(UQ_ENV_HELP),
88  m_numSubEnvironments(UQ_ENV_NUM_SUB_ENVIRONMENTS_ODV),
89  m_subDisplayFileName(UQ_ENV_SUB_DISPLAY_FILE_NAME_ODV),
90  m_subDisplayAllowAll(UQ_ENV_SUB_DISPLAY_ALLOW_ALL_ODV),
91  m_subDisplayAllowInter0(UQ_ENV_SUB_DISPLAY_ALLOW_INTER0_ODV),
92  //m_subDisplayAllowedSet (),
93  m_displayVerbosity(UQ_ENV_DISPLAY_VERBOSITY_ODV),
94  m_syncVerbosity(UQ_ENV_SYNC_VERBOSITY_ODV),
95  m_checkingLevel(UQ_ENV_CHECKING_LEVEL_ODV),
96  m_rngType(UQ_ENV_RNG_TYPE_ODV),
97  m_seed(UQ_ENV_SEED_ODV),
98  m_platformName(UQ_ENV_PLATFORM_NAME_ODV),
99  m_identifyingString(UQ_ENV_IDENTIFYING_STRING_ODV),
100  m_numDebugParams(UQ_ENV_NUM_DEBUG_PARAMS_ODV),
102  m_env(env),
103 #ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
104  m_parser(new BoostInputOptionsParser(env->optionsInputFileName())),
105 #endif // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
106  m_option_help(m_prefix + "help"),
107  m_option_numSubEnvironments(m_prefix + "numSubEnvironments"),
108  m_option_subDisplayFileName(m_prefix + "subDisplayFileName"),
109  m_option_subDisplayAllowAll(m_prefix + "subDisplayAllowAll"),
110  m_option_subDisplayAllowInter0(m_prefix + "subDisplayAllowInter0"),
111  m_option_subDisplayAllowedSet(m_prefix + "subDisplayAllowedSet"),
112  m_option_displayVerbosity(m_prefix + "displayVerbosity"),
113  m_option_syncVerbosity(m_prefix + "syncVerbosity"),
114  m_option_checkingLevel(m_prefix + "checkingLevel"),
115  m_option_rngType(m_prefix + "rngType"),
116  m_option_seed(m_prefix + "seed"),
117  m_option_platformName(m_prefix + "platformName"),
118  m_option_identifyingString(m_prefix + "identifyingString")
119 {
120 #ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
121  // Register all options with parser
122  m_parser->registerOption<std::string >(m_option_help, UQ_ENV_HELP, "produce help message for environment");
123  m_parser->registerOption<unsigned int>(m_option_numSubEnvironments, UQ_ENV_NUM_SUB_ENVIRONMENTS_ODV, "number of subEnvironments");
124  m_parser->registerOption<std::string >(m_option_subDisplayFileName, UQ_ENV_SUB_DISPLAY_FILE_NAME_ODV, "output filename for subscreen writing");
125  m_parser->registerOption<bool >(m_option_subDisplayAllowAll, UQ_ENV_SUB_DISPLAY_ALLOW_ALL_ODV, "Allow all processors to write to output file");
126  m_parser->registerOption<bool >(m_option_subDisplayAllowInter0, UQ_ENV_SUB_DISPLAY_ALLOW_INTER0_ODV, "Allow all inter0 nodes to write to output file");
127  m_parser->registerOption<std::string >(m_option_subDisplayAllowedSet, UQ_ENV_SUB_DISPLAY_ALLOWED_SET_ODV, "subEnvs that will write to output file");
128  m_parser->registerOption<unsigned int>(m_option_displayVerbosity, UQ_ENV_DISPLAY_VERBOSITY_ODV, "set verbosity");
129  m_parser->registerOption<unsigned int>(m_option_syncVerbosity, UQ_ENV_SYNC_VERBOSITY_ODV, "set sync verbosity");
130  m_parser->registerOption<unsigned int>(m_option_checkingLevel, UQ_ENV_CHECKING_LEVEL_ODV, "set checking level");
131  m_parser->registerOption<std::string >(m_option_rngType, UQ_ENV_RNG_TYPE_ODV, "set rngType");
132  m_parser->registerOption<int >(m_option_seed, UQ_ENV_SEED_ODV, "set seed");
133  m_parser->registerOption<std::string >(m_option_platformName, UQ_ENV_PLATFORM_NAME_ODV, "platform name");
134  m_parser->registerOption<std::string >(m_option_identifyingString, UQ_ENV_IDENTIFYING_STRING_ODV, "identifying string");
135 
136  // Read the input file
137  m_parser->scanInputFile();
138 
139  m_parser->getOption<std::string >(m_option_help, m_help);
140  m_parser->getOption<unsigned int>(m_option_numSubEnvironments, m_numSubEnvironments);
144  m_parser->getOption<std::set<unsigned int> >(m_option_subDisplayAllowedSet, m_subDisplayAllowedSet);
145  m_parser->getOption<unsigned int>(m_option_displayVerbosity, m_displayVerbosity);
146  m_parser->getOption<unsigned int>(m_option_syncVerbosity, m_syncVerbosity);
147  m_parser->getOption<unsigned int>(m_option_checkingLevel, m_checkingLevel);
148  m_parser->getOption<std::string>(m_option_rngType, m_rngType);
149  m_parser->getOption<int>(m_option_seed, m_seed);
150  m_parser->getOption<std::string>(m_option_platformName, m_platformName);
151  m_parser->getOption<std::string>(m_option_identifyingString, m_identifyingString);
152 #else
153  m_help = m_env->input()(m_option_help, UQ_ENV_HELP);
154  m_numSubEnvironments = m_env->input()(m_option_numSubEnvironments, UQ_ENV_NUM_SUB_ENVIRONMENTS_ODV);
155  m_subDisplayFileName = m_env->input()(m_option_subDisplayFileName, UQ_ENV_SUB_DISPLAY_FILE_NAME_ODV);
156  m_subDisplayAllowAll = m_env->input()(m_option_subDisplayAllowAll, UQ_ENV_SUB_DISPLAY_ALLOW_ALL_ODV);
157  m_subDisplayAllowInter0 = m_env->input()(m_option_subDisplayAllowInter0, UQ_ENV_SUB_DISPLAY_ALLOW_INTER0_ODV);
158 
159  // UQ_ENV_SUB_DISPLAY_ALLOWED_SET_ODV is the empty set (string) by default
160  unsigned int size = m_env->input().vector_variable_size(m_option_subDisplayAllowedSet);
161  for (unsigned int i = 0; i < size; i++) {
162  // We default to empty set, so the default values are actually never
163  // used here
164  unsigned int allowed = m_env->input()(m_option_subDisplayAllowedSet, i, i);
165  m_subDisplayAllowedSet.insert(allowed);
166  }
167 
168  m_displayVerbosity = m_env->input()(m_option_displayVerbosity, UQ_ENV_DISPLAY_VERBOSITY_ODV);
169  m_syncVerbosity = m_env->input()(m_option_syncVerbosity, UQ_ENV_SYNC_VERBOSITY_ODV);
170  m_checkingLevel = m_env->input()(m_option_checkingLevel, UQ_ENV_CHECKING_LEVEL_ODV);
171  m_rngType = m_env->input()(m_option_rngType, UQ_ENV_RNG_TYPE_ODV);
172  m_seed = m_env->input()(m_option_seed, UQ_ENV_SEED_ODV);
173  m_platformName = m_env->input()(m_option_platformName, UQ_ENV_PLATFORM_NAME_ODV);
174  m_identifyingString = m_env->input()(m_option_identifyingString, UQ_ENV_IDENTIFYING_STRING_ODV);
175 #endif // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
176 
177  checkOptions();
178 }
std::string m_option_checkingLevel
Input file option name for m_checkingLevel.
bool m_subDisplayAllowAll
Allows (or not) all sub-environments to write to output file.
bool m_subDisplayAllowInter0
Allows (or not) all inter0 nodes to write to output file.
unsigned int m_checkingLevel
Checking level.
unsigned int m_numDebugParams
Number of debug parameters. Unused?
std::string m_option_identifyingString
Input file option name for m_identifyingString.
std::string m_option_displayVerbosity
Input file option name for m_displayVerbosity.
const GetPot & input() const
The GetPot input file parser.
Definition: Environment.C:1149
ScopedPtr< BoostInputOptionsParser >::Type m_parser
std::string m_option_subDisplayAllowedSet
Input file option name for m_subDisplayAllowedSet.
std::string m_option_seed
Input file option name for m_seed.
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.
std::set< unsigned int > m_subDisplayAllowedSet
Sub-environments that will write to output.
std::string m_option_subDisplayAllowAll
Input file option name for m_subDisplayAllowAll.
void checkOptions()
Sorts out any inter-option conflicts.
std::string m_option_subDisplayAllowInter0
Input file option name for m_subDisplayAllowInter0.
std::string m_rngType
Type of the random number generator.
std::string m_identifyingString
Identifying string.
std::string m_option_syncVerbosity
Input file option name for m_syncVerbosity.
std::string m_option_numSubEnvironments
Input file option name for m_numSubEnvironments.
const BaseEnvironment * m_env
unsigned int m_displayVerbosity
Verbosity.
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.
QUESO::EnvOptionsValues::EnvOptionsValues ( const EnvOptionsValues src)

Copy constructor.

Definition at line 196 of file EnvironmentOptions.C.

References copy().

197 {
198  this->copy(src);
199 }
void copy(const EnvOptionsValues &src)
Makes an exact copy of an existing EnvOptionsValues instance.
QUESO::EnvOptionsValues::~EnvOptionsValues ( )
virtual

Destructor.

Definition at line 202 of file EnvironmentOptions.C.

203 {
204 }

Member Function Documentation

void QUESO::EnvOptionsValues::checkOptions ( )
private

Sorts out any inter-option conflicts.

Definition at line 181 of file EnvironmentOptions.C.

References m_subDisplayAllowAll, m_subDisplayAllowedSet, and m_subDisplayAllowInter0.

Referenced by EnvOptionsValues().

182 {
183  // Clear the permitted set of ranks if the user specifies that all are
184  // allowed to display or the Inter0 communicator is allowed to display
185  if (m_subDisplayAllowAll) {
186  // This will get filled by the Environment after the sub communicators are
187  // created
188  m_subDisplayAllowedSet.clear();
189  }
190  else if (m_subDisplayAllowInter0) {
191  m_subDisplayAllowedSet.clear();
192  }
193 }
bool m_subDisplayAllowAll
Allows (or not) all sub-environments to write to output file.
bool m_subDisplayAllowInter0
Allows (or not) all inter0 nodes to write to output file.
std::set< unsigned int > m_subDisplayAllowedSet
Sub-environments that will write to output.
void QUESO::EnvOptionsValues::copy ( const EnvOptionsValues src)
private

Makes an exact copy of an existing EnvOptionsValues instance.

Definition at line 215 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=().

216 {
217  m_numSubEnvironments = src.m_numSubEnvironments;
218  m_subDisplayFileName = src.m_subDisplayFileName;
219  m_subDisplayAllowAll = src.m_subDisplayAllowAll;
220  m_subDisplayAllowInter0 = src.m_subDisplayAllowInter0;
221  m_subDisplayAllowedSet = src.m_subDisplayAllowedSet;
222  m_displayVerbosity = src.m_displayVerbosity;
223  m_syncVerbosity = src.m_syncVerbosity;
224  m_checkingLevel = src.m_checkingLevel;
225  m_rngType = src.m_rngType;
226  m_seed = src.m_seed;
227  m_platformName = src.m_platformName;
228  m_identifyingString = src.m_identifyingString;
229  m_numDebugParams = src.m_numDebugParams;
230  m_debugParams = src.m_debugParams;
231 
232  return;
233 }
bool m_subDisplayAllowAll
Allows (or not) all sub-environments to write to output file.
bool m_subDisplayAllowInter0
Allows (or not) all inter0 nodes to write to output file.
unsigned int m_checkingLevel
Checking level.
unsigned int m_numDebugParams
Number of debug parameters. Unused?
std::string m_platformName
Platform name.
std::set< unsigned int > m_subDisplayAllowedSet
Sub-environments that will write to output.
std::string m_rngType
Type of the random number generator.
std::string m_identifyingString
Identifying string.
unsigned int m_displayVerbosity
Verbosity.
std::string m_subDisplayFileName
Output filename for sub-screen writing.
int m_seed
Seed of the random number generator.
std::vector< double > m_debugParams
Debug parameters. Unused?
unsigned int m_syncVerbosity
Synchronized verbosity.
EnvOptionsValues & QUESO::EnvOptionsValues::operator= ( const EnvOptionsValues rhs)

Operator for copying the options of an environment.

Definition at line 208 of file EnvironmentOptions.C.

References copy().

209 {
210  this->copy(rhs);
211  return *this;
212 }
void copy(const EnvOptionsValues &src)
Makes an exact copy of an existing EnvOptionsValues instance.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const EnvOptionsValues obj 
)
friend

Print values of the options chosen.

Definition at line 235 of file EnvironmentOptions.C.

236 {
237  // Print the parser
238 #ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
239  os << (*(obj.m_parser)) << std::endl;
240 #else
241  obj.m_env->input().print(os);
242 #endif // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
243 
244  // Print the option names and current values
245  os << obj.m_option_numSubEnvironments << " = " << obj.m_numSubEnvironments
246  << "\n" << obj.m_option_subDisplayFileName << " = " << obj.m_subDisplayFileName
247  << "\n" << obj.m_option_subDisplayAllowAll << " = " << obj.m_subDisplayAllowAll
248  //<< "\n" << obj.m_option_subDisplayAllowInter0 << " = " << obj.m_subDisplayAllowInter0
249  << "\n" << obj.m_option_subDisplayAllowedSet << " = ";
250  for (std::set<unsigned int>::iterator setIt = obj.m_subDisplayAllowedSet.begin(); setIt != obj.m_subDisplayAllowedSet.end(); ++setIt) {
251  os << *setIt << " ";
252  }
253  os << "\n" << obj.m_option_displayVerbosity << " = " << obj.m_displayVerbosity
254  << "\n" << obj.m_option_syncVerbosity << " = " << obj.m_syncVerbosity
255  << "\n" << obj.m_option_checkingLevel << " = " << obj.m_checkingLevel
256  << "\n" << obj.m_option_rngType << " = " << obj.m_rngType
257  << "\n" << obj.m_option_seed << " = " << obj.m_seed
258  << "\n" << obj.m_option_platformName << " = " << obj.m_platformName
259  << "\n" << obj.m_option_identifyingString << " = " << obj.m_identifyingString
260  //<< "\n" << obj.m_option_numDebugParams << " = " << obj.m_numDebugParams
261  << std::endl;
262  return os;
263 }

Member Data Documentation

unsigned int QUESO::EnvOptionsValues::m_checkingLevel
std::vector<double> QUESO::EnvOptionsValues::m_debugParams

Debug parameters. Unused?

Definition at line 170 of file EnvironmentOptions.h.

Referenced by copy().

unsigned int QUESO::EnvOptionsValues::m_displayVerbosity
const BaseEnvironment* QUESO::EnvOptionsValues::m_env
private

Definition at line 174 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues(), and QUESO::operator<<().

std::string QUESO::EnvOptionsValues::m_help

Definition at line 111 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues().

std::string QUESO::EnvOptionsValues::m_identifyingString
unsigned int QUESO::EnvOptionsValues::m_numDebugParams

Number of debug parameters. Unused?

Definition at line 167 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 115 of file EnvironmentOptions.h.

Referenced by copy(), EnvOptionsValues(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::operator<<(), and QUESO::EnvironmentOptions::print().

std::string QUESO::EnvOptionsValues::m_option_checkingLevel
private

Input file option name for m_checkingLevel.

Definition at line 205 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues(), and QUESO::operator<<().

std::string QUESO::EnvOptionsValues::m_option_displayVerbosity
private

Input file option name for m_displayVerbosity.

Definition at line 199 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues(), and QUESO::operator<<().

std::string QUESO::EnvOptionsValues::m_option_help
private

Input file option name for flagging helpful printing output.

Definition at line 181 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues().

std::string QUESO::EnvOptionsValues::m_option_identifyingString
private

Input file option name for m_identifyingString.

Definition at line 217 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues(), and QUESO::operator<<().

std::string QUESO::EnvOptionsValues::m_option_numSubEnvironments
private

Input file option name for m_numSubEnvironments.

Definition at line 184 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues(), and QUESO::operator<<().

std::string QUESO::EnvOptionsValues::m_option_platformName
private

Input file option name for m_platformName.

Definition at line 214 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues(), and QUESO::operator<<().

std::string QUESO::EnvOptionsValues::m_option_rngType
private

Input file option name for m_rngType.

Definition at line 208 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues(), and QUESO::operator<<().

std::string QUESO::EnvOptionsValues::m_option_seed
private

Input file option name for m_seed.

Definition at line 211 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues(), and QUESO::operator<<().

std::string QUESO::EnvOptionsValues::m_option_subDisplayAllowAll
private

Input file option name for m_subDisplayAllowAll.

Definition at line 190 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues(), and QUESO::operator<<().

std::string QUESO::EnvOptionsValues::m_option_subDisplayAllowedSet
private

Input file option name for m_subDisplayAllowedSet.

Definition at line 196 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues(), and QUESO::operator<<().

std::string QUESO::EnvOptionsValues::m_option_subDisplayAllowInter0
private

Input file option name for m_subDisplayAllowInter0.

Definition at line 193 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues().

std::string QUESO::EnvOptionsValues::m_option_subDisplayFileName
private

Input file option name for m_subDisplayFileName.

Definition at line 187 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues(), and QUESO::operator<<().

std::string QUESO::EnvOptionsValues::m_option_syncVerbosity
private

Input file option name for m_syncVerbosity.

Definition at line 202 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues(), and QUESO::operator<<().

ScopedPtr<BoostInputOptionsParser>::Type QUESO::EnvOptionsValues::m_parser
private

Definition at line 177 of file EnvironmentOptions.h.

Referenced by EnvOptionsValues(), and QUESO::operator<<().

std::string QUESO::EnvOptionsValues::m_platformName
std::string QUESO::EnvOptionsValues::m_prefix

Definition at line 107 of file EnvironmentOptions.h.

std::string QUESO::EnvOptionsValues::m_rngType
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 158 of file EnvironmentOptions.h.

Referenced by copy(), EnvOptionsValues(), 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 124 of file EnvironmentOptions.h.

Referenced by checkOptions(), copy(), EnvOptionsValues(), 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 137 of file EnvironmentOptions.h.

Referenced by checkOptions(), copy(), EnvOptionsValues(), 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 130 of file EnvironmentOptions.h.

Referenced by checkOptions(), copy(), EnvOptionsValues(), and QUESO::EnvironmentOptions::getMyOptionValues().

std::string QUESO::EnvOptionsValues::m_subDisplayFileName

Output filename for sub-screen writing.

Definition at line 118 of file EnvironmentOptions.h.

Referenced by copy(), EnvOptionsValues(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::operator<<(), and QUESO::EnvironmentOptions::print().

unsigned int QUESO::EnvOptionsValues::m_syncVerbosity

The documentation for this class was generated from the following files:

Generated on Tue Jun 5 2018 19:49:06 for queso-0.57.1 by  doxygen 1.8.5