QUESO::EnvironmentOptions Class Reference

This class reads options one can pass to a QUESO environment through an input file. More...

#include <EnvironmentOptions.h>

Collaboration diagram for QUESO::EnvironmentOptions:

Public Member Functions
Constructor/Destructor methods
	EnvironmentOptions (const BaseEnvironment &env, const char *prefix)
	Default constructor. More...
	EnvironmentOptions (const BaseEnvironment &env, const char *prefix, const EnvOptionsValues &alternativeOptionsValues)
	Constructor with alternative options values. More...
	~EnvironmentOptions ()
	Destructor. More...
I/O methods
void	scanOptionsValues ()
	Scans option values from input file. More...
void	print (std::ostream &os) const
	Print values of the options chosen. More...

Public Attributes
EnvOptionsValues	m_ov
	Instance of EnvOptionsValues, a class with default values for QUESO environment. More...

Private Member Functions
void	defineMyOptions (boost::program_options::options_description &optionsDesc) const
	Define my environment options as the default options. More...
void	getMyOptionValues (boost::program_options::options_description &optionsDesc)
	Gets the option values of the environment. More...

Private Attributes
const BaseEnvironment &	m_env
	Environment. More...
std::string	m_prefix
	Options prefix. More...
boost::program_options::options_description *	m_optionsDesc
	Environment options description. More...
std::string	m_option_help
std::string	m_option_numSubEnvironments
	My number of sub-environments. More...
std::string	m_option_subDisplayFileName
	My output filename for sub-screen writing. More...
std::string	m_option_subDisplayAllowAll
	Allows (or not) all sub-environments to write to output file. More...
std::string	m_option_subDisplayAllowInter0
	Allows (or not) all inter0 nodes to write to output file. More...
std::string	m_option_subDisplayAllowedSet
	Sub-environments that will write to output. More...
std::string	m_option_displayVerbosity
	Verbosity. More...
std::string	m_option_syncVerbosity
	Synchronized verbosity. More...
std::string	m_option_checkingLevel
	Checking level. More...
std::string	m_option_rngType
	Type of the random number generator. More...
std::string	m_option_seed
	Seed of the random number generator. More...
std::string	m_option_platformName
	Platform name. More...
std::string	m_option_identifyingString
	Identifying string. More...

Detailed Description

This class reads options one can pass to a QUESO environment through an input file.

QUESO expects the user to provide an input file with environment options for the library variables. This class reads the input options for QUESO environment variables.

Definition at line 233 of file EnvironmentOptions.h.

Constructor & Destructor Documentation

QUESO::EnvironmentOptions::EnvironmentOptions	(	const BaseEnvironment &	env,
		const char *	prefix
	)

Default constructor.

Assigns the default suite of options to the environment.

Definition at line 271 of file EnvironmentOptions.C.

References m_env, QUESO::BaseEnvironment::optionsInputFileName(), queso_deprecated, and queso_require_not_equal_to_msg.

  :
  m_ov                          (),
  m_env                         (env),
  m_prefix                      ((std::string)(prefix) + "env_"),
#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  m_optionsDesc                 (new boost::program_options::options_description("Environment options")),
#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_deprecated();
  queso_require_not_equal_to_msg(m_env.optionsInputFileName(), std::string(""), std::string("this constructor is incompatible with the abscense of an options input file"));
}

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

Constructor with alternative options values.

Definition at line 299 of file EnvironmentOptions.C.

References m_env, m_prefix, QUESO::BaseEnvironment::optionsInputFileName(), queso_deprecated, queso_require_equal_to_msg, and QUESO::BaseEnvironment::subDisplayFile().

  :
  m_ov                          (alternativeOptionsValues),
  m_env                         (env),
  m_prefix                      ((std::string)(prefix) + "env_"),
#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  m_optionsDesc                 (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_deprecated();
  queso_require_equal_to_msg(m_env.optionsInputFileName(), std::string(""), std::string("this constructor is incompatible with the existence of an options input file"));

  if (m_env.subDisplayFile() != NULL) {
    *m_env.subDisplayFile() << "In EnvironmentOptions::constructor(2)"
                            << ": after setting values of options with prefix '" << m_prefix
                            << "', state of object is:"
                            << "\n" << *this
                            << std::endl;
  }
}

QUESO::EnvironmentOptions::~EnvironmentOptions

(

)

Destructor.

Definition at line 336 of file EnvironmentOptions.C.

References m_optionsDesc, and queso_deprecated.

{
  queso_deprecated();

#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  if (m_optionsDesc) delete m_optionsDesc;
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS
}

Member Function Documentation

void QUESO::EnvironmentOptions::defineMyOptions ( boost::program_options::options_description &  optionsDesc ) const

private

Define my environment options as the default options.

Definition at line 402 of file EnvironmentOptions.C.

References 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, queso_deprecated, UQ_ENV_CHECKING_LEVEL_ODV, UQ_ENV_DISPLAY_VERBOSITY_ODV, 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.

Referenced by scanOptionsValues().

{
  queso_deprecated();

#ifdef QUESO_MEMORY_DEBUGGING
  std::cout << "In EnvOptions::defineMyOptions(), before add_options()" << std::endl;
#endif
  optionsDesc.add_options()
    (m_option_help.c_str(),                                                                                                 "produce help message for  environment"       )
    (m_option_numSubEnvironments.c_str(),    boost::program_options::value<unsigned int>()->default_value(UQ_ENV_NUM_SUB_ENVIRONMENTS_ODV),     "number of subEnvironments"                     )
    (m_option_subDisplayFileName.c_str(),    boost::program_options::value<std::string >()->default_value(UQ_ENV_SUB_DISPLAY_FILE_NAME_ODV),    "output filename for subscreen writing"         )
    (m_option_subDisplayAllowAll.c_str(),    boost::program_options::value<bool        >()->default_value(UQ_ENV_SUB_DISPLAY_ALLOW_ALL_ODV),    "Allow all processors to write to output file"  )
    (m_option_subDisplayAllowInter0.c_str(), boost::program_options::value<bool        >()->default_value(UQ_ENV_SUB_DISPLAY_ALLOW_INTER0_ODV), "Allow all inter0 nodes to write to output file")
    (m_option_subDisplayAllowedSet.c_str(),  boost::program_options::value<std::string >()->default_value(UQ_ENV_SUB_DISPLAY_ALLOWED_SET_ODV),  "subEnvs that will write to output file"        )
    (m_option_displayVerbosity.c_str(),      boost::program_options::value<unsigned int>()->default_value(UQ_ENV_DISPLAY_VERBOSITY_ODV),        "set verbosity"                                 )
    (m_option_syncVerbosity.c_str(),         boost::program_options::value<unsigned int>()->default_value(UQ_ENV_SYNC_VERBOSITY_ODV),           "set sync verbosity"                            )
    (m_option_checkingLevel.c_str(),         boost::program_options::value<unsigned int>()->default_value(UQ_ENV_CHECKING_LEVEL_ODV),           "set checking level"                            )
    (m_option_rngType.c_str(),               boost::program_options::value<std::string >()->default_value(UQ_ENV_RNG_TYPE_ODV),                 "set rngType"                                   )
    (m_option_seed.c_str(),                  boost::program_options::value<int         >()->default_value(UQ_ENV_SEED_ODV),                     "set seed"                                      )
    (m_option_platformName.c_str(),          boost::program_options::value<std::string >()->default_value(UQ_ENV_PLATFORM_NAME_ODV),            "platform name"                                 )
    (m_option_identifyingString.c_str(),     boost::program_options::value<std::string >()->default_value(UQ_ENV_IDENTIFYING_STRING_ODV),       "identifying string"                            )
  //(m_option_numDebugParams.c_str(),        boost::program_options::value<unsigned int>()->default_value(UQ_ENV_NUM_DEBUG_PARAMS_ODV),         "set number of debug parameters"                )
  ;
#ifdef QUESO_MEMORY_DEBUGGING
  std::cout << "In EnvOptions::defineMyOptions(), after add_options()" << std::endl;
#endif

  return;
}

void QUESO::EnvironmentOptions::getMyOptionValues ( boost::program_options::options_description &  optionsDesc )

private

Gets the option values of the environment.

Definition at line 433 of file EnvironmentOptions.C.

References QUESO::BaseEnvironment::allOptionsMap(), QUESO::BaseEnvironment::fullComm(), QUESO::BaseEnvironment::fullRank(), QUESO::EnvOptionsValues::m_checkingLevel, QUESO::EnvOptionsValues::m_displayVerbosity, m_env, QUESO::EnvOptionsValues::m_identifyingString, QUESO::EnvOptionsValues::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_ov, QUESO::EnvOptionsValues::m_platformName, QUESO::EnvOptionsValues::m_rngType, QUESO::EnvOptionsValues::m_seed, QUESO::EnvOptionsValues::m_subDisplayAllowAll, QUESO::EnvOptionsValues::m_subDisplayAllowedSet, QUESO::EnvOptionsValues::m_subDisplayAllowInter0, QUESO::EnvOptionsValues::m_subDisplayFileName, QUESO::EnvOptionsValues::m_syncVerbosity, QUESO::MiscReadDoublesFromString(), QUESO::MpiComm::NumProc(), queso_deprecated, and queso_require_equal_to_msg.

Referenced by scanOptionsValues().

{
  queso_deprecated();

#ifdef QUESO_MEMORY_DEBUGGING
  std::cout << "Entering EnvOptions::getMyOptionsValues()" << std::endl;
#endif
  if (m_env.allOptionsMap().count(m_option_help.c_str())) {
    // 'm_subDisplayOutputFile' is still not available at this moment. Use 'std::cout'
    if (m_env.fullRank() == 0) std::cout << optionsDesc
                                         << std::endl;
  }

  if (m_env.allOptionsMap().count(m_option_numSubEnvironments.c_str())) {
    m_ov.m_numSubEnvironments = m_env.allOptionsMap()[m_option_numSubEnvironments].as<unsigned int>();
  }
  if ((m_env.fullComm().NumProc()%m_ov.m_numSubEnvironments) != 0) {
    std::cerr << "In BaseEnvironment::getMyOptionValues()"
              << ": m_env.fullComm().NumProc() = " << m_env.fullComm().NumProc()
              << ", m_numSubEnvironments = "       << m_ov.m_numSubEnvironments
              << std::endl;
  }
  queso_require_equal_to_msg((m_env.fullComm().NumProc()%m_ov.m_numSubEnvironments), 0, "total number of processors in environment must be multiple of the specified number of subEnvironments");

  if (m_env.allOptionsMap().count(m_option_subDisplayFileName.c_str())) {
    m_ov.m_subDisplayFileName = m_env.allOptionsMap()[m_option_subDisplayFileName].as<std::string>();
  }

  if (m_env.allOptionsMap().count(m_option_subDisplayAllowAll.c_str())) {
    m_ov.m_subDisplayAllowAll = m_env.allOptionsMap()[m_option_subDisplayAllowAll].as<bool>();
  }

  if (m_env.allOptionsMap().count(m_option_subDisplayAllowInter0.c_str())) {
    m_ov.m_subDisplayAllowInter0 = m_env.allOptionsMap()[m_option_subDisplayAllowInter0].as<bool>();
  }

  if (m_ov.m_subDisplayAllowAll) {
    m_ov.m_subDisplayAllowedSet.clear();
    // The line below is commented because 'm_subId' is not set at this point yet
    //m_subDisplayAllowedSet.insert((unsigned int) m_subId);
  }
  else if (m_ov.m_subDisplayAllowInter0) {
    m_ov.m_subDisplayAllowedSet.clear();
  }
  else if (m_env.allOptionsMap().count(m_option_subDisplayAllowedSet.c_str())) {
    m_ov.m_subDisplayAllowedSet.clear();
    std::vector<double> tmpAllow(0,0.);
    std::string inputString = m_env.allOptionsMap()[m_option_subDisplayAllowedSet].as<std::string>();
    MiscReadDoublesFromString(inputString,tmpAllow);
    //if (m_subDisplayOutputFile) {
    //  *m_subDisplayOutputFile << "In EnvironmentOptions::getMyOptionValues(): allow = ";
    //  for (unsigned int i = 0; i < tmpAllow.size(); ++i) {
    //    *m_subDisplayOutputFile << " " << tmpAllow[i];
    //  }
    //  *m_subDisplayOutputFile << std::endl;
    //}

    if (tmpAllow.size() > 0) {
      for (unsigned int i = 0; i < tmpAllow.size(); ++i) {
        m_ov.m_subDisplayAllowedSet.insert((unsigned int) tmpAllow[i]);
      }
    }
  }

  if (m_env.allOptionsMap().count(m_option_displayVerbosity.c_str())) {
    m_ov.m_displayVerbosity = m_env.allOptionsMap()[m_option_displayVerbosity].as<unsigned int>();
  }

  if (m_env.allOptionsMap().count(m_option_syncVerbosity.c_str())) {
    m_ov.m_syncVerbosity = m_env.allOptionsMap()[m_option_syncVerbosity].as<unsigned int>();
  }

  if (m_env.allOptionsMap().count(m_option_checkingLevel.c_str())) {
    m_ov.m_checkingLevel = m_env.allOptionsMap()[m_option_checkingLevel].as<unsigned int>();
  }

  if (m_env.allOptionsMap().count(m_option_rngType.c_str())) {
    m_ov.m_rngType = m_env.allOptionsMap()[m_option_rngType].as<std::string>();
  }

  if (m_env.allOptionsMap().count(m_option_seed.c_str())) {
    m_ov.m_seed = m_env.allOptionsMap()[m_option_seed].as<int>();
  }

  if (m_env.allOptionsMap().count(m_option_platformName.c_str())) {
    m_ov.m_platformName = m_env.allOptionsMap()[m_option_platformName].as<std::string>();
  }

  if (m_env.allOptionsMap().count(m_option_identifyingString.c_str())) {
    m_ov.m_identifyingString = m_env.allOptionsMap()[m_option_identifyingString].as<std::string>();
  }

  //if (m_env.allOptionsMap().count(m_option_numDebugParams.c_str())) {
  //  m_numDebugParams = m_env.allOptionsMap()[m_option_numDebugParams].as<unsigned int>();
  //}

#ifdef QUESO_MEMORY_DEBUGGING
  std::cout << "Leaving EnvOptions::getMyOptionsValues()" << std::endl;
#endif

  return;
}

void QUESO::EnvironmentOptions::print

(

std::ostream &

os

)

const

Print values of the options chosen.

Definition at line 375 of file EnvironmentOptions.C.

References QUESO::EnvOptionsValues::m_checkingLevel, QUESO::EnvOptionsValues::m_displayVerbosity, QUESO::EnvOptionsValues::m_identifyingString, QUESO::EnvOptionsValues::m_numSubEnvironments, m_option_checkingLevel, m_option_displayVerbosity, m_option_identifyingString, m_option_numSubEnvironments, m_option_platformName, m_option_rngType, m_option_seed, m_option_subDisplayAllowAll, m_option_subDisplayAllowedSet, m_option_subDisplayFileName, m_option_syncVerbosity, m_ov, QUESO::EnvOptionsValues::m_platformName, QUESO::EnvOptionsValues::m_rngType, QUESO::EnvOptionsValues::m_seed, QUESO::EnvOptionsValues::m_subDisplayAllowAll, QUESO::EnvOptionsValues::m_subDisplayAllowedSet, QUESO::EnvOptionsValues::m_subDisplayFileName, QUESO::EnvOptionsValues::m_syncVerbosity, and queso_deprecated.

Referenced by QUESO::operator<<().

{
  queso_deprecated();

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

void QUESO::EnvironmentOptions::scanOptionsValues

(

)

Scans option values from input file.

Definition at line 347 of file EnvironmentOptions.C.

References defineMyOptions(), QUESO::BaseEnvironment::displayVerbosity(), QUESO::BaseEnvironment::fullRank(), getMyOptionValues(), m_env, m_optionsDesc, m_prefix, queso_deprecated, queso_require_msg, and QUESO::BaseEnvironment::scanInputFileForMyOptions().

{
  queso_deprecated();
#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  queso_require_msg(m_optionsDesc, "m_optionsDesc variable is NULL");
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS

#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  defineMyOptions                (*m_optionsDesc);
  m_env.scanInputFileForMyOptions(*m_optionsDesc);
  getMyOptionValues              (*m_optionsDesc);
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS

  // 'm_subDisplayOutputFile' is still not available at this moment. Use 'std::cout'
  //if (m_env.subScreenFile() != NULL) {
  //  *m_env.subScreenFile()
  if ((m_env.fullRank() == 0) && (m_env.displayVerbosity() >= 3)) {
    std::cout << "In EnvironmentOptions::scanOptionsValues()"
              << ": after reading values of options with prefix '" << m_prefix
              << "', state of object is:"
              << "\n" << *this
              << std::endl;
  }

  return;
}

Member Data Documentation

const BaseEnvironment& QUESO::EnvironmentOptions::m_env

private

Environment.

Definition at line 272 of file EnvironmentOptions.h.

Referenced by EnvironmentOptions(), getMyOptionValues(), and scanOptionsValues().

std::string QUESO::EnvironmentOptions::m_option_checkingLevel

private

Checking level.

Definition at line 309 of file EnvironmentOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::EnvironmentOptions::m_option_displayVerbosity

private

Verbosity.

Definition at line 303 of file EnvironmentOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::EnvironmentOptions::m_option_help

private

Definition at line 285 of file EnvironmentOptions.h.

Referenced by defineMyOptions(), and getMyOptionValues().

std::string QUESO::EnvironmentOptions::m_option_identifyingString

private

Identifying string.

Definition at line 323 of file EnvironmentOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::EnvironmentOptions::m_option_numSubEnvironments

private

My number of sub-environments.

Definition at line 288 of file EnvironmentOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::EnvironmentOptions::m_option_platformName

private

Platform name.

Definition at line 320 of file EnvironmentOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::EnvironmentOptions::m_option_rngType

private

Type of the random number generator.

Definition at line 312 of file EnvironmentOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::EnvironmentOptions::m_option_seed

private

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

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::EnvironmentOptions::m_option_subDisplayAllowAll

private

Allows (or not) all sub-environments to write to output file.

Definition at line 294 of file EnvironmentOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::EnvironmentOptions::m_option_subDisplayAllowedSet

private

Sub-environments that will write to output.

Definition at line 300 of file EnvironmentOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::EnvironmentOptions::m_option_subDisplayAllowInter0

private

Allows (or not) all inter0 nodes to write to output file.

Definition at line 297 of file EnvironmentOptions.h.

Referenced by defineMyOptions(), and getMyOptionValues().

std::string QUESO::EnvironmentOptions::m_option_subDisplayFileName

private

My output filename for sub-screen writing.

Definition at line 291 of file EnvironmentOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::EnvironmentOptions::m_option_syncVerbosity

private

Synchronized verbosity.

Definition at line 306 of file EnvironmentOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

boost::program_options::options_description* QUESO::EnvironmentOptions::m_optionsDesc

private

Environment options description.

Uses boost::program_options::options_description. A set of option descriptions. This provides convenient interface for adding new option method, and facilities to search for options by name.

Definition at line 282 of file EnvironmentOptions.h.

Referenced by scanOptionsValues(), and ~EnvironmentOptions().

EnvOptionsValues QUESO::EnvironmentOptions::m_ov

Instance of EnvOptionsValues, a class with default values for QUESO environment.

Definition at line 260 of file EnvironmentOptions.h.

Referenced by getMyOptionValues(), and print().

std::string QUESO::EnvironmentOptions::m_prefix

private

Options prefix.

Definition at line 275 of file EnvironmentOptions.h.

Referenced by EnvironmentOptions(), and scanOptionsValues().

---

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

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