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...

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 105 of file Defines.h.

Constructor & Destructor Documentation

QUESO::EnvOptionsValues::EnvOptionsValues ( )

Default constructor.

Definition at line 37 of file EnvironmentOptions.C.

   :
   m_numSubEnvironments   (UQ_ENV_NUM_SUB_ENVIRONMENTS_ODV),
   m_subDisplayFileName   (UQ_ENV_SUB_DISPLAY_FILE_NAME_ODV),
   m_subDisplayAllowAll   (UQ_ENV_SUB_DISPLAY_ALLOW_ALL_ODV),
   m_subDisplayAllowInter0(UQ_ENV_SUB_DISPLAY_ALLOW_INTER0_ODV),
 //m_subDisplayAllowedSet (),
   m_displayVerbosity     (UQ_ENV_DISPLAY_VERBOSITY_ODV),
   m_syncVerbosity        (UQ_ENV_SYNC_VERBOSITY_ODV),
   m_checkingLevel        (UQ_ENV_CHECKING_LEVEL_ODV),
   m_rngType              (UQ_ENV_RNG_TYPE_ODV),
   m_seed                 (UQ_ENV_SEED_ODV),
   m_platformName         (UQ_ENV_PLATFORM_NAME_ODV),
   m_identifyingString    (UQ_ENV_IDENTIFYING_STRING_ODV),
   m_numDebugParams       (UQ_ENV_NUM_DEBUG_PARAMS_ODV),
   m_debugParams          (m_numDebugParams,0.)
 {
 }

QUESO::EnvOptionsValues::EnvOptionsValues ( const EnvOptionsValues & src )

Copy constructor.

Definition at line 57 of file EnvironmentOptions.C.

References copy().

 {
   this->copy(src);
 }

QUESO::EnvOptionsValues::~EnvOptionsValues ( )

Destructor.

Definition at line 63 of file EnvironmentOptions.C.

64 {

65 }

Member Function Documentation

void QUESO::EnvOptionsValues::copy ( const EnvOptionsValues & src )

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=().

 {
   m_numSubEnvironments    = src.m_numSubEnvironments;
   m_subDisplayFileName    = src.m_subDisplayFileName;
   m_subDisplayAllowAll    = src.m_subDisplayAllowAll;
   m_subDisplayAllowInter0 = src.m_subDisplayAllowInter0;
   m_subDisplayAllowedSet  = src.m_subDisplayAllowedSet;
   m_displayVerbosity      = src.m_displayVerbosity;
   m_syncVerbosity         = src.m_syncVerbosity;
   m_checkingLevel         = src.m_checkingLevel;
   m_rngType               = src.m_rngType;
   m_seed                  = src.m_seed;
   m_platformName          = src.m_platformName;
   m_identifyingString     = src.m_identifyingString;
   m_numDebugParams        = src.m_numDebugParams;
   m_debugParams           = src.m_debugParams;
 
   return;
 }

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().

 {
   this->copy(rhs);
   return *this;
 }

Member Data Documentation

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

Debug parameters.

Definition at line 169 of file Defines.h.

Referenced by copy().

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

Number of debug parameters.

Definition at line 166 of file Defines.h.

Referenced by copy().

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.