queso-0.53.0
Public Attributes | Private Member Functions | Private Attributes | Friends | List of all members
QUESO::EnvOptionsValues Class Reference

This class provides a suite options one can pass to a QUESO environment. More...

#include <EnvironmentOptions.h>

Collaboration diagram for QUESO::EnvOptionsValues:
Collaboration graph
[legend]

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

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

Constructor & Destructor Documentation

QUESO::EnvOptionsValues::EnvOptionsValues ( )

Default constructor.

Definition at line 39 of file EnvironmentOptions.C.

40  :
41  m_prefix("env_"),
47  //m_subDisplayAllowedSet (),
57  m_parser(NULL),
58  m_option_help(m_prefix + "help"),
59  m_option_numSubEnvironments(m_prefix + "numSubEnvironments"),
60  m_option_subDisplayFileName(m_prefix + "subDisplayFileName"),
61  m_option_subDisplayAllowAll(m_prefix + "subDisplayAllowAll"),
62  m_option_subDisplayAllowInter0(m_prefix + "subDisplayAllowInter0"),
63  m_option_subDisplayAllowedSet(m_prefix + "subDisplayAllowedSet"),
64  m_option_displayVerbosity(m_prefix + "displayVerbosity"),
65  m_option_syncVerbosity(m_prefix + "syncVerbosity"),
66  m_option_checkingLevel(m_prefix + "checkingLevel"),
67  m_option_rngType(m_prefix + "rngType"),
68  m_option_seed(m_prefix + "seed"),
69  m_option_platformName(m_prefix + "platformName"),
70  m_option_identifyingString(m_prefix + "identifyingString")
71 {
72 }
#define UQ_ENV_SUB_DISPLAY_FILE_NAME_ODV
#define UQ_ENV_NUM_SUB_ENVIRONMENTS_ODV
#define UQ_ENV_SUB_DISPLAY_ALLOW_ALL_ODV
std::string m_option_rngType
Input file option name for m_rngType.
std::string m_option_subDisplayAllowInter0
Input file option name for m_subDisplayAllowInter0.
std::string m_option_seed
Input file option name for m_seed.
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.
#define UQ_ENV_RNG_TYPE_ODV
#define UQ_ENV_CHECKING_LEVEL_ODV
unsigned int m_checkingLevel
Checking level.
#define UQ_ENV_PLATFORM_NAME_ODV
int m_seed
Seed of the random number generator.
unsigned int m_syncVerbosity
Synchronized verbosity.
unsigned int m_displayVerbosity
Verbosity.
std::string m_option_identifyingString
Input file option name for m_identifyingString.
std::string m_subDisplayFileName
Output filename for sub-screen writing.
std::string m_option_platformName
Input file option name for m_platformName.
std::string m_option_displayVerbosity
Input file option name for m_displayVerbosity.
#define UQ_ENV_HELP
#define UQ_ENV_SUB_DISPLAY_ALLOW_INTER0_ODV
#define UQ_ENV_NUM_DEBUG_PARAMS_ODV
std::string m_option_syncVerbosity
Input file option name for m_syncVerbosity.
#define UQ_ENV_DISPLAY_VERBOSITY_ODV
#define UQ_ENV_SYNC_VERBOSITY_ODV
unsigned int m_numDebugParams
Number of debug parameters. Unused?
bool m_subDisplayAllowAll
Allows (or not) all sub-environments to write to output file.
BoostInputOptionsParser * m_parser
std::string m_option_subDisplayAllowAll
Input file option name for m_subDisplayAllowAll.
std::vector< double > m_debugParams
Debug parameters. Unused?
std::string m_option_subDisplayAllowedSet
Input file option name for m_subDisplayAllowedSet.
std::string m_rngType
Type of the random number generator.
std::string m_platformName
Platform name.
std::string m_identifyingString
Identifying string.
std::string m_option_checkingLevel
Input file option name for m_checkingLevel.
bool m_subDisplayAllowInter0
Allows (or not) all inter0 nodes to write to output file.
#define UQ_ENV_IDENTIFYING_STRING_ODV
#define UQ_ENV_SEED_ODV
std::string m_option_numSubEnvironments
Input file option name for m_numSubEnvironments.
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.

76  :
77  m_prefix((std::string) + "env_"),
83  //m_subDisplayAllowedSet (),
93  m_parser(new BoostInputOptionsParser(env->optionsInputFileName())),
94  m_option_help(m_prefix + "help"),
95  m_option_numSubEnvironments(m_prefix + "numSubEnvironments"),
96  m_option_subDisplayFileName(m_prefix + "subDisplayFileName"),
97  m_option_subDisplayAllowAll(m_prefix + "subDisplayAllowAll"),
98  m_option_subDisplayAllowInter0(m_prefix + "subDisplayAllowInter0"),
99  m_option_subDisplayAllowedSet(m_prefix + "subDisplayAllowedSet"),
100  m_option_displayVerbosity(m_prefix + "displayVerbosity"),
101  m_option_syncVerbosity(m_prefix + "syncVerbosity"),
102  m_option_checkingLevel(m_prefix + "checkingLevel"),
103  m_option_rngType(m_prefix + "rngType"),
104  m_option_seed(m_prefix + "seed"),
105  m_option_platformName(m_prefix + "platformName"),
106  m_option_identifyingString(m_prefix + "identifyingString")
107 {
108  // Register all options with parser
109  m_parser->registerOption<std::string >(m_option_help, UQ_ENV_HELP, "produce help message for environment");
110  m_parser->registerOption<unsigned int>(m_option_numSubEnvironments, UQ_ENV_NUM_SUB_ENVIRONMENTS_ODV, "number of subEnvironments");
111  m_parser->registerOption<std::string >(m_option_subDisplayFileName, UQ_ENV_SUB_DISPLAY_FILE_NAME_ODV, "output filename for subscreen writing");
112  m_parser->registerOption<bool >(m_option_subDisplayAllowAll, UQ_ENV_SUB_DISPLAY_ALLOW_ALL_ODV, "Allow all processors to write to output file");
113  m_parser->registerOption<bool >(m_option_subDisplayAllowInter0, UQ_ENV_SUB_DISPLAY_ALLOW_INTER0_ODV, "Allow all inter0 nodes to write to output file");
114  m_parser->registerOption<std::string >(m_option_subDisplayAllowedSet, UQ_ENV_SUB_DISPLAY_ALLOWED_SET_ODV, "subEnvs that will write to output file");
116  m_parser->registerOption<unsigned int>(m_option_syncVerbosity, UQ_ENV_SYNC_VERBOSITY_ODV, "set sync verbosity");
117  m_parser->registerOption<unsigned int>(m_option_checkingLevel, UQ_ENV_CHECKING_LEVEL_ODV, "set checking level");
118  m_parser->registerOption<std::string >(m_option_rngType, UQ_ENV_RNG_TYPE_ODV, "set rngType");
120  m_parser->registerOption<std::string >(m_option_platformName, UQ_ENV_PLATFORM_NAME_ODV, "platform name");
122 
123  // Read the input file
125 
126  m_parser->getOption<std::string >(m_option_help, m_help);
139 
140  checkOptions();
141 }
#define UQ_ENV_SUB_DISPLAY_FILE_NAME_ODV
#define UQ_ENV_NUM_SUB_ENVIRONMENTS_ODV
#define UQ_ENV_SUB_DISPLAY_ALLOW_ALL_ODV
std::string m_option_rngType
Input file option name for m_rngType.
std::string m_option_subDisplayAllowInter0
Input file option name for m_subDisplayAllowInter0.
std::string m_option_seed
Input file option name for m_seed.
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.
#define UQ_ENV_RNG_TYPE_ODV
#define UQ_ENV_CHECKING_LEVEL_ODV
unsigned int m_checkingLevel
Checking level.
#define UQ_ENV_PLATFORM_NAME_ODV
int m_seed
Seed of the random number generator.
unsigned int m_syncVerbosity
Synchronized verbosity.
unsigned int m_displayVerbosity
Verbosity.
std::string m_option_identifyingString
Input file option name for m_identifyingString.
std::string m_subDisplayFileName
Output filename for sub-screen writing.
std::string m_option_platformName
Input file option name for m_platformName.
#define UQ_ENV_SUB_DISPLAY_ALLOWED_SET_ODV
std::string m_option_displayVerbosity
Input file option name for m_displayVerbosity.
#define UQ_ENV_HELP
#define UQ_ENV_SUB_DISPLAY_ALLOW_INTER0_ODV
#define UQ_ENV_NUM_DEBUG_PARAMS_ODV
void scanInputFile()
This is the method that parses the input file.
std::string m_option_syncVerbosity
Input file option name for m_syncVerbosity.
#define UQ_ENV_DISPLAY_VERBOSITY_ODV
#define UQ_ENV_SYNC_VERBOSITY_ODV
unsigned int m_numDebugParams
Number of debug parameters. Unused?
bool m_subDisplayAllowAll
Allows (or not) all sub-environments to write to output file.
BoostInputOptionsParser * m_parser
std::set< unsigned int > m_subDisplayAllowedSet
Sub-environments that will write to output.
void registerOption(std::string name, T defaultValue, std::string description)
Call this to register an option with the parser.
std::string m_option_subDisplayAllowAll
Input file option name for m_subDisplayAllowAll.
std::vector< double > m_debugParams
Debug parameters. Unused?
std::string m_option_subDisplayAllowedSet
Input file option name for m_subDisplayAllowedSet.
std::string m_rngType
Type of the random number generator.
std::string m_platformName
Platform name.
std::string m_identifyingString
Identifying string.
std::string m_option_checkingLevel
Input file option name for m_checkingLevel.
bool m_subDisplayAllowInter0
Allows (or not) all inter0 nodes to write to output file.
#define UQ_ENV_IDENTIFYING_STRING_ODV
void getOption(std::string &name, T &value)
Get option name from the parser and set value to the parsed value.
void checkOptions()
Sorts out any inter-option conflicts.
#define UQ_ENV_SEED_ODV
std::string m_option_numSubEnvironments
Input file option name for m_numSubEnvironments.
QUESO::EnvOptionsValues::EnvOptionsValues ( const EnvOptionsValues src)

Copy constructor.

Definition at line 159 of file EnvironmentOptions.C.

References copy().

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

Destructor.

Definition at line 165 of file EnvironmentOptions.C.

References m_parser.

166 {
167  if (m_parser) {
168  delete m_parser;
169  }
170 }
BoostInputOptionsParser * m_parser

Member Function Documentation

void QUESO::EnvOptionsValues::checkOptions ( )
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().

145 {
146  // Clear the permitted set of ranks if the user specifies that all are
147  // allowed to display or the Inter0 communicator is allowed to display
148  if (m_subDisplayAllowAll) {
149  // This will get filled by the Environment after the sub communicators are
150  // created
151  m_subDisplayAllowedSet.clear();
152  }
153  else if (m_subDisplayAllowInter0) {
154  m_subDisplayAllowedSet.clear();
155  }
156 }
bool m_subDisplayAllowAll
Allows (or not) all sub-environments to write to output file.
std::set< unsigned int > m_subDisplayAllowedSet
Sub-environments that will write to output.
bool m_subDisplayAllowInter0
Allows (or not) all inter0 nodes to write to output file.
void QUESO::EnvOptionsValues::copy ( const EnvOptionsValues src)
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=().

182 {
183  m_numSubEnvironments = src.m_numSubEnvironments;
184  m_subDisplayFileName = src.m_subDisplayFileName;
185  m_subDisplayAllowAll = src.m_subDisplayAllowAll;
186  m_subDisplayAllowInter0 = src.m_subDisplayAllowInter0;
187  m_subDisplayAllowedSet = src.m_subDisplayAllowedSet;
188  m_displayVerbosity = src.m_displayVerbosity;
189  m_syncVerbosity = src.m_syncVerbosity;
190  m_checkingLevel = src.m_checkingLevel;
191  m_rngType = src.m_rngType;
192  m_seed = src.m_seed;
193  m_platformName = src.m_platformName;
194  m_identifyingString = src.m_identifyingString;
195  m_numDebugParams = src.m_numDebugParams;
196  m_debugParams = src.m_debugParams;
197 
198  return;
199 }
unsigned int m_checkingLevel
Checking level.
int m_seed
Seed of the random number generator.
unsigned int m_syncVerbosity
Synchronized verbosity.
unsigned int m_displayVerbosity
Verbosity.
std::string m_subDisplayFileName
Output filename for sub-screen writing.
unsigned int m_numDebugParams
Number of debug parameters. Unused?
bool m_subDisplayAllowAll
Allows (or not) all sub-environments to write to output file.
std::set< unsigned int > m_subDisplayAllowedSet
Sub-environments that will write to output.
std::vector< double > m_debugParams
Debug parameters. Unused?
std::string m_rngType
Type of the random number generator.
std::string m_platformName
Platform name.
std::string m_identifyingString
Identifying string.
bool m_subDisplayAllowInter0
Allows (or not) all inter0 nodes to write to output file.
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().

175 {
176  this->copy(rhs);
177  return *this;
178 }
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 201 of file EnvironmentOptions.C.

202 {
203  // Print the parser
204  os << (*(obj.m_parser)) << std::endl;
205 
206  // Print the option names and current values
207  os << obj.m_option_numSubEnvironments << " = " << obj.m_numSubEnvironments
208  << "\n" << obj.m_option_subDisplayFileName << " = " << obj.m_subDisplayFileName
209  << "\n" << obj.m_option_subDisplayAllowAll << " = " << obj.m_subDisplayAllowAll
210  //<< "\n" << obj.m_option_subDisplayAllowInter0 << " = " << obj.m_subDisplayAllowInter0
211  << "\n" << obj.m_option_subDisplayAllowedSet << " = ";
212  for (std::set<unsigned int>::iterator setIt = obj.m_subDisplayAllowedSet.begin(); setIt != obj.m_subDisplayAllowedSet.end(); ++setIt) {
213  os << *setIt << " ";
214  }
215  os << "\n" << obj.m_option_displayVerbosity << " = " << obj.m_displayVerbosity
216  << "\n" << obj.m_option_syncVerbosity << " = " << obj.m_syncVerbosity
217  << "\n" << obj.m_option_checkingLevel << " = " << obj.m_checkingLevel
218  << "\n" << obj.m_option_rngType << " = " << obj.m_rngType
219  << "\n" << obj.m_option_seed << " = " << obj.m_seed
220  << "\n" << obj.m_option_platformName << " = " << obj.m_platformName
221  << "\n" << obj.m_option_identifyingString << " = " << obj.m_identifyingString
222  //<< "\n" << obj.m_option_numDebugParams << " = " << obj.m_numDebugParams
223  << std::endl;
224  return os;
225 }

Member Data Documentation

unsigned int QUESO::EnvOptionsValues::m_checkingLevel
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
std::string QUESO::EnvOptionsValues::m_help
std::string QUESO::EnvOptionsValues::m_identifyingString
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
std::string QUESO::EnvOptionsValues::m_option_checkingLevel
private

Input file option name for m_checkingLevel.

Definition at line 194 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 188 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 170 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 206 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 173 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 203 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 197 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 200 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 179 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 185 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 182 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 176 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 191 of file EnvironmentOptions.h.

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

BoostInputOptionsParser* QUESO::EnvOptionsValues::m_parser
private

Definition at line 167 of file EnvironmentOptions.h.

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

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

Definition at line 100 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 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
unsigned int QUESO::EnvOptionsValues::m_syncVerbosity

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

Generated on Thu Jun 11 2015 13:52:34 for queso-0.53.0 by  doxygen 1.8.5