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:

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
EnvOptionsValues &	operator= (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 BaseEnvironment *	m_env
BoostInputOptionsParser *	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 82 of file EnvironmentOptions.h.

Constructor & Destructor Documentation

QUESO::EnvOptionsValues::EnvOptionsValues

(

)

Default constructor.

Definition at line 41 of file EnvironmentOptions.C.

  :
    m_prefix("env_"),
    m_help(UQ_ENV_HELP),
    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.),
    m_env(NULL),
#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
    m_parser(NULL),
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS
    m_option_help(m_prefix + "help"),
    m_option_numSubEnvironments(m_prefix + "numSubEnvironments"),
    m_option_subDisplayFileName(m_prefix + "subDisplayFileName"),
    m_option_subDisplayAllowAll(m_prefix + "subDisplayAllowAll"),
    m_option_subDisplayAllowInter0(m_prefix + "subDisplayAllowInter0"),
    m_option_subDisplayAllowedSet(m_prefix + "subDisplayAllowedSet"),
    m_option_displayVerbosity(m_prefix + "displayVerbosity"),
    m_option_syncVerbosity(m_prefix + "syncVerbosity"),
    m_option_checkingLevel(m_prefix + "checkingLevel"),
    m_option_rngType(m_prefix + "rngType"),
    m_option_seed(m_prefix + "seed"),
    m_option_platformName(m_prefix + "platformName"),
    m_option_identifyingString(m_prefix + "identifyingString")
{
}

QUESO::EnvOptionsValues::EnvOptionsValues	(	const BaseEnvironment *	env,
		const char *	prefix
	)

Definition at line 79 of file EnvironmentOptions.C.

References checkOptions(), QUESO::BoostInputOptionsParser::getOption(), 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, 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, UQ_ENV_SYNC_VERBOSITY_ODV, and GetPot::vector_variable_size().

  :
    m_prefix((std::string) + "env_"),
    m_help(UQ_ENV_HELP),
    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.),
    m_env(env),
#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
    m_parser(new BoostInputOptionsParser(env->optionsInputFileName())),
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS
    m_option_help(m_prefix + "help"),
    m_option_numSubEnvironments(m_prefix + "numSubEnvironments"),
    m_option_subDisplayFileName(m_prefix + "subDisplayFileName"),
    m_option_subDisplayAllowAll(m_prefix + "subDisplayAllowAll"),
    m_option_subDisplayAllowInter0(m_prefix + "subDisplayAllowInter0"),
    m_option_subDisplayAllowedSet(m_prefix + "subDisplayAllowedSet"),
    m_option_displayVerbosity(m_prefix + "displayVerbosity"),
    m_option_syncVerbosity(m_prefix + "syncVerbosity"),
    m_option_checkingLevel(m_prefix + "checkingLevel"),
    m_option_rngType(m_prefix + "rngType"),
    m_option_seed(m_prefix + "seed"),
    m_option_platformName(m_prefix + "platformName"),
    m_option_identifyingString(m_prefix + "identifyingString")
{
#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  // Register all options with parser
  m_parser->registerOption<std::string >(m_option_help, UQ_ENV_HELP, "produce help message for environment");
  m_parser->registerOption<unsigned int>(m_option_numSubEnvironments, UQ_ENV_NUM_SUB_ENVIRONMENTS_ODV, "number of subEnvironments");
  m_parser->registerOption<std::string >(m_option_subDisplayFileName, UQ_ENV_SUB_DISPLAY_FILE_NAME_ODV, "output filename for subscreen writing");
  m_parser->registerOption<bool        >(m_option_subDisplayAllowAll, UQ_ENV_SUB_DISPLAY_ALLOW_ALL_ODV, "Allow all processors to write to output file");
  m_parser->registerOption<bool        >(m_option_subDisplayAllowInter0, UQ_ENV_SUB_DISPLAY_ALLOW_INTER0_ODV, "Allow all inter0 nodes to write to output file");
  m_parser->registerOption<std::string >(m_option_subDisplayAllowedSet, UQ_ENV_SUB_DISPLAY_ALLOWED_SET_ODV, "subEnvs that will write to output file");
  m_parser->registerOption<unsigned int>(m_option_displayVerbosity, UQ_ENV_DISPLAY_VERBOSITY_ODV, "set verbosity");
  m_parser->registerOption<unsigned int>(m_option_syncVerbosity, UQ_ENV_SYNC_VERBOSITY_ODV, "set sync verbosity");
  m_parser->registerOption<unsigned int>(m_option_checkingLevel, UQ_ENV_CHECKING_LEVEL_ODV, "set checking level");
  m_parser->registerOption<std::string >(m_option_rngType, UQ_ENV_RNG_TYPE_ODV, "set rngType");
  m_parser->registerOption<int         >(m_option_seed, UQ_ENV_SEED_ODV, "set seed");
  m_parser->registerOption<std::string >(m_option_platformName, UQ_ENV_PLATFORM_NAME_ODV, "platform name");
  m_parser->registerOption<std::string >(m_option_identifyingString, UQ_ENV_IDENTIFYING_STRING_ODV, "identifying string");

  // Read the input file
  m_parser->scanInputFile();

  m_parser->getOption<std::string >(m_option_help, m_help);
  m_parser->getOption<unsigned int>(m_option_numSubEnvironments, m_numSubEnvironments);
  m_parser->getOption<std::string>(m_option_subDisplayFileName, m_subDisplayFileName);
  m_parser->getOption<bool>(m_option_subDisplayAllowAll, m_subDisplayAllowAll);
  m_parser->getOption<bool>(m_option_subDisplayAllowInter0, m_subDisplayAllowInter0);
  m_parser->getOption<std::set<unsigned int> >(m_option_subDisplayAllowedSet, m_subDisplayAllowedSet);
  m_parser->getOption<unsigned int>(m_option_displayVerbosity, m_displayVerbosity);
  m_parser->getOption<unsigned int>(m_option_syncVerbosity, m_syncVerbosity);
  m_parser->getOption<unsigned int>(m_option_checkingLevel, m_checkingLevel);
  m_parser->getOption<std::string>(m_option_rngType, m_rngType);
  m_parser->getOption<int>(m_option_seed, m_seed);
  m_parser->getOption<std::string>(m_option_platformName, m_platformName);
  m_parser->getOption<std::string>(m_option_identifyingString, m_identifyingString);
#else
  m_help = m_env->input()(m_option_help, UQ_ENV_HELP);
  m_numSubEnvironments = m_env->input()(m_option_numSubEnvironments, UQ_ENV_NUM_SUB_ENVIRONMENTS_ODV);
  m_subDisplayFileName = m_env->input()(m_option_subDisplayFileName, UQ_ENV_SUB_DISPLAY_FILE_NAME_ODV);
  m_subDisplayAllowAll = m_env->input()(m_option_subDisplayAllowAll, UQ_ENV_SUB_DISPLAY_ALLOW_ALL_ODV);
  m_subDisplayAllowInter0 = m_env->input()(m_option_subDisplayAllowInter0, UQ_ENV_SUB_DISPLAY_ALLOW_INTER0_ODV);

  // UQ_ENV_SUB_DISPLAY_ALLOWED_SET_ODV is the empty set (string) by default
  unsigned int size = m_env->input().vector_variable_size(m_option_subDisplayAllowedSet);
  for (unsigned int i = 0; i < size; i++) {
    // We default to empty set, so the default values are actually never
    // used here
    unsigned int allowed = m_env->input()(m_option_subDisplayAllowedSet, i, i);
    m_subDisplayAllowedSet.insert(allowed);
  }

  m_displayVerbosity = m_env->input()(m_option_displayVerbosity, UQ_ENV_DISPLAY_VERBOSITY_ODV);
  m_syncVerbosity = m_env->input()(m_option_syncVerbosity, UQ_ENV_SYNC_VERBOSITY_ODV);
  m_checkingLevel = m_env->input()(m_option_checkingLevel, UQ_ENV_CHECKING_LEVEL_ODV);
  m_rngType = m_env->input()(m_option_rngType, UQ_ENV_RNG_TYPE_ODV);
  m_seed = m_env->input()(m_option_seed, UQ_ENV_SEED_ODV);
  m_platformName = m_env->input()(m_option_platformName, UQ_ENV_PLATFORM_NAME_ODV);
  m_identifyingString = m_env->input()(m_option_identifyingString, UQ_ENV_IDENTIFYING_STRING_ODV);
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS

  checkOptions();
}

QUESO::EnvOptionsValues::EnvOptionsValues

(

const EnvOptionsValues &

src

)

Copy constructor.

Definition at line 192 of file EnvironmentOptions.C.

References copy().

{
  this->copy(src);
}

QUESO::EnvOptionsValues::~EnvOptionsValues ( )

virtual

Destructor.

Definition at line 198 of file EnvironmentOptions.C.

References m_parser.

{
#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  if (m_parser) {
    delete m_parser;
  }
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS
}

Member Function Documentation

void QUESO::EnvOptionsValues::checkOptions ( )

private

Sorts out any inter-option conflicts.

Definition at line 177 of file EnvironmentOptions.C.

References m_subDisplayAllowAll, m_subDisplayAllowedSet, and m_subDisplayAllowInter0.

Referenced by EnvOptionsValues().

{
  // Clear the permitted set of ranks if the user specifies that all are
  // allowed to display or the Inter0 communicator is allowed to display
  if (m_subDisplayAllowAll) {
    // This will get filled by the Environment after the sub communicators are
    // created
    m_subDisplayAllowedSet.clear();
  }
  else if (m_subDisplayAllowInter0) {
    m_subDisplayAllowedSet.clear();
  }
}

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

private

Makes an exact copy of an existing EnvOptionsValues instance.

Definition at line 216 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 209 of file EnvironmentOptions.C.

References copy().

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

Friends And Related Function Documentation

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

friend

Print values of the options chosen.

Definition at line 236 of file EnvironmentOptions.C.

{
  // Print the parser
#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  os << (*(obj.m_parser)) << std::endl;
#else
  obj.m_env->input().print(os);
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS

  // Print the option names and current values
  os <<         obj.m_option_numSubEnvironments    << " = " << obj.m_numSubEnvironments
     << "\n" << obj.m_option_subDisplayFileName    << " = " << obj.m_subDisplayFileName
     << "\n" << obj.m_option_subDisplayAllowAll    << " = " << obj.m_subDisplayAllowAll
   //<< "\n" << obj.m_option_subDisplayAllowInter0 << " = " << obj.m_subDisplayAllowInter0
     << "\n" << obj.m_option_subDisplayAllowedSet  << " = ";
  for (std::set<unsigned int>::iterator setIt = obj.m_subDisplayAllowedSet.begin(); setIt != obj.m_subDisplayAllowedSet.end(); ++setIt) {
    os << *setIt << " ";
  }
  os << "\n" << obj.m_option_displayVerbosity  << " = " << obj.m_displayVerbosity
     << "\n" << obj.m_option_syncVerbosity     << " = " << obj.m_syncVerbosity
     << "\n" << obj.m_option_checkingLevel     << " = " << obj.m_checkingLevel
     << "\n" << obj.m_option_rngType           << " = " << obj.m_rngType
     << "\n" << obj.m_option_seed              << " = " << obj.m_seed
     << "\n" << obj.m_option_platformName      << " = " << obj.m_platformName
     << "\n" << obj.m_option_identifyingString << " = " << obj.m_identifyingString
   //<< "\n" << obj.m_option_numDebugParams    << " = " << obj.m_numDebugParams
     << std::endl;
  return os;
}

Member Data Documentation

unsigned int QUESO::EnvOptionsValues::m_checkingLevel

Checking level.

Definition at line 143 of file EnvironmentOptions.h.

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

std::vector<double> QUESO::EnvOptionsValues::m_debugParams

Debug parameters. Unused?

Definition at line 167 of file EnvironmentOptions.h.

Referenced by copy().

unsigned int QUESO::EnvOptionsValues::m_displayVerbosity

Verbosity.

Definition at line 137 of file EnvironmentOptions.h.

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

const BaseEnvironment* QUESO::EnvOptionsValues::m_env

private

Definition at line 171 of file EnvironmentOptions.h.

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

std::string QUESO::EnvOptionsValues::m_help

Definition at line 108 of file EnvironmentOptions.h.

Referenced by QUESO::FullEnvironment::construct(), and EnvOptionsValues().

std::string QUESO::EnvOptionsValues::m_identifyingString

Identifying string.

Definition at line 161 of file EnvironmentOptions.h.

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

unsigned int QUESO::EnvOptionsValues::m_numDebugParams

Number of debug parameters. Unused?

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

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

std::string QUESO::EnvOptionsValues::m_option_checkingLevel

private

Input file option name for m_checkingLevel.

Definition at line 202 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 196 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 178 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 214 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 181 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 211 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 205 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 208 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 187 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 193 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 190 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 184 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 199 of file EnvironmentOptions.h.

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

BoostInputOptionsParser* QUESO::EnvOptionsValues::m_parser

private

Definition at line 174 of file EnvironmentOptions.h.

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

std::string QUESO::EnvOptionsValues::m_platformName

Platform name.

Definition at line 158 of file EnvironmentOptions.h.

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

std::string QUESO::EnvOptionsValues::m_prefix

Definition at line 104 of file EnvironmentOptions.h.

std::string QUESO::EnvOptionsValues::m_rngType

Type of the random number generator.

Definition at line 146 of file EnvironmentOptions.h.

Referenced by QUESO::FullEnvironment::construct(), copy(), EnvOptionsValues(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::operator<<(), 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 155 of file EnvironmentOptions.h.

Referenced by QUESO::FullEnvironment::construct(), 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 121 of file EnvironmentOptions.h.

Referenced by checkOptions(), QUESO::FullEnvironment::construct(), 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 134 of file EnvironmentOptions.h.

Referenced by checkOptions(), QUESO::FullEnvironment::construct(), 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 127 of file EnvironmentOptions.h.

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

std::string QUESO::EnvOptionsValues::m_subDisplayFileName

Output filename for sub-screen writing.

Definition at line 115 of file EnvironmentOptions.h.

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

unsigned int QUESO::EnvOptionsValues::m_syncVerbosity

Synchronized verbosity.

Definition at line 140 of file EnvironmentOptions.h.

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

---

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

• src/core/inc/EnvironmentOptions.h
• src/core/src/EnvironmentOptions.C