queso-0.52.0
|
This class provides a suite options one can pass to a QUESO environment. More...
#include <Defines.h>
Public Member Functions | |
Constructor/Destructor methods | |
EnvOptionsValues () | |
Default constructor. More... | |
EnvOptionsValues (const EnvOptionsValues &src) | |
Copy constructor. More... | |
~EnvOptionsValues () | |
Destructor. More... | |
Set methods | |
EnvOptionsValues & | operator= (const EnvOptionsValues &rhs) |
Operator for copying the options of an environment. More... | |
Public Attributes | |
Attributes | |
unsigned int | m_numSubEnvironments |
Number of sub-environments. More... | |
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. More... | |
std::vector< double > | m_debugParams |
Debug parameters. More... | |
Private Member Functions | |
void | copy (const EnvOptionsValues &src) |
Makes an exact copy of an existing EnvOptionsValues instance. 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.
QUESO::EnvOptionsValues::EnvOptionsValues | ( | ) |
Default constructor.
Definition at line 37 of file EnvironmentOptions.C.
QUESO::EnvOptionsValues::EnvOptionsValues | ( | const EnvOptionsValues & | src | ) |
Copy constructor.
Definition at line 57 of file EnvironmentOptions.C.
References copy().
QUESO::EnvOptionsValues::~EnvOptionsValues | ( | ) |
|
private |
Makes an exact copy of an existing EnvOptionsValues instance.
Definition at line 76 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 69 of file EnvironmentOptions.C.
References copy().
unsigned int QUESO::EnvOptionsValues::m_checkingLevel |
Checking level.
Definition at line 149 of file Defines.h.
Referenced by QUESO::BaseEnvironment::checkingLevel(), copy(), QUESO::EnvironmentOptions::getMyOptionValues(), and QUESO::EnvironmentOptions::print().
std::vector<double> QUESO::EnvOptionsValues::m_debugParams |
unsigned int QUESO::EnvOptionsValues::m_displayVerbosity |
Verbosity.
Definition at line 143 of file Defines.h.
Referenced by copy(), QUESO::BaseEnvironment::displayVerbosity(), QUESO::EnvironmentOptions::getMyOptionValues(), and QUESO::EnvironmentOptions::print().
std::string QUESO::EnvOptionsValues::m_identifyingString |
Identifying string.
Definition at line 163 of file Defines.h.
Referenced by copy(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::BaseEnvironment::identifyingString(), and QUESO::EnvironmentOptions::print().
unsigned int QUESO::EnvOptionsValues::m_numDebugParams |
unsigned int QUESO::EnvOptionsValues::m_numSubEnvironments |
Number of sub-environments.
Definition at line 128 of file Defines.h.
Referenced by copy(), QUESO::FullEnvironment::FullEnvironment(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::BaseEnvironment::numSubEnvironments(), and QUESO::EnvironmentOptions::print().
std::string QUESO::EnvOptionsValues::m_platformName |
Platform name.
Definition at line 160 of file Defines.h.
Referenced by copy(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::BaseEnvironment::platformName(), and QUESO::EnvironmentOptions::print().
std::string QUESO::EnvOptionsValues::m_rngType |
Type of the random number generator.
Definition at line 152 of file Defines.h.
Referenced by copy(), QUESO::FullEnvironment::FullEnvironment(), QUESO::EnvironmentOptions::getMyOptionValues(), 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 157 of file Defines.h.
Referenced by copy(), QUESO::FullEnvironment::FullEnvironment(), QUESO::EnvironmentOptions::getMyOptionValues(), and QUESO::EnvironmentOptions::print().
bool QUESO::EnvOptionsValues::m_subDisplayAllowAll |
Allows (or not) all sub-environments to write to output file.
Definition at line 134 of file Defines.h.
Referenced by copy(), QUESO::FullEnvironment::FullEnvironment(), QUESO::EnvironmentOptions::getMyOptionValues(), and QUESO::EnvironmentOptions::print().
std::set<unsigned int> QUESO::EnvOptionsValues::m_subDisplayAllowedSet |
Sub-environments that will write to output.
Definition at line 140 of file Defines.h.
Referenced by copy(), QUESO::FullEnvironment::FullEnvironment(), QUESO::EnvironmentOptions::getMyOptionValues(), and QUESO::EnvironmentOptions::print().
bool QUESO::EnvOptionsValues::m_subDisplayAllowInter0 |
Allows (or not) all inter0 nodes to write to output file.
Definition at line 137 of file Defines.h.
Referenced by copy(), QUESO::FullEnvironment::FullEnvironment(), and QUESO::EnvironmentOptions::getMyOptionValues().
std::string QUESO::EnvOptionsValues::m_subDisplayFileName |
Output filename for sub-screen writing.
Definition at line 131 of file Defines.h.
Referenced by copy(), QUESO::FullEnvironment::FullEnvironment(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::EnvironmentOptions::print(), and QUESO::BaseEnvironment::subDisplayFileName().
unsigned int QUESO::EnvOptionsValues::m_syncVerbosity |
Synchronized verbosity.
Definition at line 146 of file Defines.h.
Referenced by copy(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::EnvironmentOptions::print(), and QUESO::BaseEnvironment::syncVerbosity().