This class provides options for the Multilevel sequence generator if no input file is available. More...

#include <MLSamplingOptions.h>

Collaboration diagram for QUESO::MLSamplingOptions:

Public Member Functions
Constructor/Destructor methods
	MLSamplingOptions (const BaseEnvironment &env, const char *prefix)
	Default constructor. More...

	~MLSamplingOptions ()
	Destructor. More...

I/O methods
void	scanOptionsValues ()
	It scans the option values from the options input file. More...

void	print (std::ostream &os) const
	It prints the option values. More...

Public Attributes
std::string	m_prefix
	Class prefix. (ml) More...

std::string	m_restartInputFileName
	Name of restart input file. More...

std::string	m_restartInputFileType
	Type of restart input file. More...

unsigned int	m_restartChainSize
	Size of restart chain. More...

std::string	m_dataOutputFileName
	Name of generic output file. More...

bool	m_dataOutputAllowAll
	subEnvs that will write to generic output file More...

std::set< unsigned int >	m_dataOutputAllowedSet

Private Member Functions
void	defineMyOptions (po::options_description &optionsDesc) const
	Defines the options for the Multilevel generator of samples as the default options. More...

void	getMyOptionValues (po::options_description &optionsDesc)
	Gets the sequence options defined to the Multilevel algorithm. More...

Private Attributes
const BaseEnvironment &	m_env

po::options_description *	m_optionsDesc

std::string	m_option_help

std::string	m_option_restartInputFileName

std::string	m_option_restartInputFileType

std::string	m_option_restartChainSize

std::string	m_option_dataOutputFileName

std::string	m_option_dataOutputAllowAll

std::string	m_option_dataOutputAllowedSet

Detailed Description

This class provides options for the Multilevel sequence generator if no input file is available.

Multilevel sequence generator expects options for its methods. This class provides default values for such options if no input file is available.

Definition at line 67 of file MLSamplingOptions.h.

Constructor & Destructor Documentation

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

Default constructor.

Assigns the default suite of options to the Multilevel sequence generator.

Definition at line 30 of file MLSamplingOptions.C.

   :
   m_prefix                               ((std::string)(prefix) + "ml_"                        ),
 #ifdef ML_CODE_HAS_NEW_RESTART_CAPABILITY
   m_restartOutput_levelPeriod            (UQ_ML_SAMPLING_RESTART_OUTPUT_LEVEL_PERIOD_ODV       ),
   m_restartOutput_baseNameForFiles       (UQ_ML_SAMPLING_RESTART_OUTPUT_BASE_NAME_FOR_FILES_ODV),
   m_restartOutput_fileType               (UQ_ML_SAMPLING_RESTART_OUTPUT_FILE_TYPE_ODV          ),
   m_restartInput_baseNameForFiles        (UQ_ML_SAMPLING_RESTART_INPUT_BASE_NAME_FOR_FILES_ODV ),
   m_restartInput_fileType                (UQ_ML_SAMPLING_RESTART_INPUT_FILE_TYPE_ODV           ),
 #else
   m_restartInputFileName                 (UQ_ML_SAMPLING_RESTART_INPUT_FILE_NAME_ODV),
   m_restartInputFileType                 (UQ_ML_SAMPLING_RESTART_INPUT_FILE_TYPE_ODV),
   m_restartChainSize                     (UQ_ML_SAMPLING_RESTART_CHAIN_SIZE_ODV     ),
 #endif
   m_dataOutputFileName                   (UQ_ML_SAMPLING_DATA_OUTPUT_FILE_NAME_ODV  ),
 //m_dataOutputAllowedSet                 (),
   m_env                                  (env),
   m_optionsDesc                          (new po::options_description("Multilevel sampling options")),
   m_option_help                          (m_prefix + "help"                          ),
 #ifdef ML_CODE_HAS_NEW_RESTART_CAPABILITY
   m_option_restartOutput_levelPeriod     (m_prefix + "restartOutput_levelPeriod"     ),
   m_option_restartOutput_baseNameForFiles(m_prefix + "restartOutput_baseNameForFiles"),
   m_option_restartOutput_fileType        (m_prefix + "restartOutput_fileType"        ),
   m_option_restartInput_baseNameForFiles (m_prefix + "restartInput_baseNameForFiles" ),
   m_option_restartInput_fileType         (m_prefix + "restartInput_fileType"         ),
 #else
   m_option_restartInputFileName          (m_prefix + "restartInputFileName"),
   m_option_restartInputFileType          (m_prefix + "restartInputFileType"),
   m_option_restartChainSize              (m_prefix + "restartChainSize"    ),
 #endif
   m_option_dataOutputFileName            (m_prefix + "dataOutputFileName"  ),
   m_option_dataOutputAllowedSet          (m_prefix + "dataOutputAllowedSet")
 {
 }

QUESO::MLSamplingOptions::~MLSamplingOptions ( )

Destructor.

Definition at line 65 of file MLSamplingOptions.C.

References m_optionsDesc.

 {
   if (m_optionsDesc) delete m_optionsDesc;
 } 

Member Function Documentation

void QUESO::MLSamplingOptions::defineMyOptions ( po::options_description & optionsDesc ) const

private

Defines the options for the Multilevel generator of samples as the default options.

Definition at line 89 of file MLSamplingOptions.C.

References m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, m_option_restartChainSize, m_option_restartInputFileName, m_option_restartInputFileType, ML_CODE_HAS_NEW_RESTART_CAPABILITY, UQ_ML_SAMPLING_DATA_OUTPUT_ALLOWED_SET_ODV, UQ_ML_SAMPLING_DATA_OUTPUT_FILE_NAME_ODV, UQ_ML_SAMPLING_RESTART_CHAIN_SIZE_ODV, UQ_ML_SAMPLING_RESTART_INPUT_FILE_NAME_ODV, and UQ_ML_SAMPLING_RESTART_INPUT_FILE_TYPE_ODV.

Referenced by scanOptionsValues().

 {
   optionsDesc.add_options()     
     (m_option_help.c_str(),                                                                                                                            "produce help msg for ML sampling options"      )
 #ifdef ML_CODE_HAS_NEW_RESTART_CAPABILITY
     (m_option_restartOutput_levelPeriod.c_str(),      po::value<unsigned int>()->default_value(UQ_ML_SAMPLING_RESTART_OUTPUT_LEVEL_PERIOD_ODV),        "restartOutput_levelPeriod"                     )
     (m_option_restartOutput_baseNameForFiles.c_str(), po::value<std::string >()->default_value(UQ_ML_SAMPLING_RESTART_OUTPUT_BASE_NAME_FOR_FILES_ODV), "restartOutput_baseNameForFiles"                )
     (m_option_restartOutput_fileType.c_str(),         po::value<std::string >()->default_value(UQ_ML_SAMPLING_RESTART_OUTPUT_FILE_TYPE_ODV),           "restartOutput_fileType"                        )
     (m_option_restartInput_baseNameForFiles.c_str(),  po::value<std::string >()->default_value(UQ_ML_SAMPLING_RESTART_INPUT_BASE_NAME_FOR_FILES_ODV),  "restartInput_baseNameForFiles"                 )
     (m_option_restartInput_fileType.c_str(),          po::value<std::string >()->default_value(UQ_ML_SAMPLING_RESTART_INPUT_FILE_TYPE_ODV),            "restartInput_fileType"                         )
 #else
     (m_option_restartInputFileName.c_str(),           po::value<std::string >()->default_value(UQ_ML_SAMPLING_RESTART_INPUT_FILE_NAME_ODV),            "name of restart input file"                    )
     (m_option_restartInputFileType.c_str(),           po::value<std::string >()->default_value(UQ_ML_SAMPLING_RESTART_INPUT_FILE_TYPE_ODV),            "type of restart input file"                    )
     (m_option_restartChainSize.c_str(),               po::value<unsigned int>()->default_value(UQ_ML_SAMPLING_RESTART_CHAIN_SIZE_ODV),                 "size of restart chain"                         )
 #endif
     (m_option_dataOutputFileName.c_str(),             po::value<std::string >()->default_value(UQ_ML_SAMPLING_DATA_OUTPUT_FILE_NAME_ODV  ),            "name of generic output file"                   )
     (m_option_dataOutputAllowedSet.c_str(),           po::value<std::string >()->default_value(UQ_ML_SAMPLING_DATA_OUTPUT_ALLOWED_SET_ODV),            "subEnvs that will write to generic output file")
   ;
 
   return;
 }

void QUESO::MLSamplingOptions::getMyOptionValues ( po::options_description & optionsDesc )

private

Gets the sequence options defined to the Multilevel algorithm.

Definition at line 112 of file MLSamplingOptions.C.

References QUESO::BaseEnvironment::allOptionsMap(), m_dataOutputAllowedSet, m_dataOutputFileName, m_env, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, m_option_restartChainSize, m_option_restartInputFileName, m_option_restartInputFileType, m_restartChainSize, m_restartInputFileName, m_restartInputFileType, QUESO::MiscReadDoublesFromString(), QUESO::BaseEnvironment::subDisplayFile(), UQ_FATAL_TEST_MACRO, and QUESO::BaseEnvironment::worldRank().

Referenced by scanOptionsValues().

 {
   if (m_env.allOptionsMap().count(m_option_help.c_str())) {
     if (m_env.subDisplayFile()) {
       *m_env.subDisplayFile() << optionsDesc
                               << std::endl;
     }
   }
 
 #ifdef ML_CODE_HAS_NEW_RESTART_CAPABILITY
   if (m_env.allOptionsMap().count(m_option_restartOutput_levelPeriod.c_str())) {
     m_restartOutput_levelPeriod = ((const po::variable_value&) m_env.allOptionsMap()[m_option_restartOutput_levelPeriod.c_str()]).as<unsigned int>();
   }
 
   if (m_env.allOptionsMap().count(m_option_restartOutput_baseNameForFiles.c_str())) {
     m_restartOutput_baseNameForFiles = ((const po::variable_value&) m_env.allOptionsMap()[m_option_restartOutput_baseNameForFiles.c_str()]).as<std::string>();
   }
 
   UQ_FATAL_TEST_MACRO((m_restartOutput_levelPeriod > 0) && (m_restartOutput_baseNameForFiles == "."),
                       m_env.worldRank(),
                       "MLSamplingOptions::getMyOptionsValues()",
                       "Option 'restartOutput_levelPeriod' is > 0, but 'restartOutput_baseNameForFiles' is not specified...");
 
   if (m_env.allOptionsMap().count(m_option_restartOutput_fileType.c_str())) {
     m_restartOutput_fileType = ((const po::variable_value&) m_env.allOptionsMap()[m_option_restartOutput_fileType.c_str()]).as<std::string>();
   }
 
   if (m_env.allOptionsMap().count(m_option_restartInput_baseNameForFiles.c_str())) {
     m_restartInput_baseNameForFiles = ((const po::variable_value&) m_env.allOptionsMap()[m_option_restartInput_baseNameForFiles.c_str()]).as<std::string>();
   }
 
   if (m_env.allOptionsMap().count(m_option_restartInput_fileType.c_str())) {
     m_restartInput_fileType = ((const po::variable_value&) m_env.allOptionsMap()[m_option_restartInput_fileType.c_str()]).as<std::string>();
   }
 #else
   if (m_env.allOptionsMap().count(m_option_restartInputFileName.c_str())) {
     m_restartInputFileName = ((const po::variable_value&) m_env.allOptionsMap()[m_option_restartInputFileName.c_str()]).as<std::string>();
   }
 
   if (m_env.allOptionsMap().count(m_option_restartInputFileType.c_str())) {
     m_restartInputFileType = ((const po::variable_value&) m_env.allOptionsMap()[m_option_restartInputFileType.c_str()]).as<std::string>();
   }
 
   if (m_env.allOptionsMap().count(m_option_restartChainSize.c_str())) {
     m_restartChainSize = ((const po::variable_value&) m_env.allOptionsMap()[m_option_restartChainSize.c_str()]).as<unsigned int>();
   }
 #endif
   if (m_env.allOptionsMap().count(m_option_dataOutputFileName.c_str())) {
     m_dataOutputFileName = ((const po::variable_value&) m_env.allOptionsMap()[m_option_dataOutputFileName.c_str()]).as<std::string>();
   }
 
   if (m_env.allOptionsMap().count(m_option_dataOutputAllowedSet.c_str())) {
     m_dataOutputAllowedSet.clear();
     std::vector<double> tmpAllow(0,0.);
     std::string inputString = m_env.allOptionsMap()[m_option_dataOutputAllowedSet.c_str()].as<std::string>();
     MiscReadDoublesFromString(inputString,tmpAllow);
 
     if (tmpAllow.size() > 0) {
       for (unsigned int i = 0; i < tmpAllow.size(); ++i) {
         m_dataOutputAllowedSet.insert((unsigned int) tmpAllow[i]);
       }
     }
   }
 
   return;
 }

void QUESO::MLSamplingOptions::print ( std::ostream & os ) const

It prints the option values.

Definition at line 180 of file MLSamplingOptions.C.

References m_dataOutputAllowedSet, m_dataOutputFileName, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_restartChainSize, m_option_restartInputFileName, m_option_restartInputFileType, m_restartChainSize, m_restartInputFileName, and m_restartInputFileType.

Referenced by QUESO::operator<<().

 {
 #ifdef ML_CODE_HAS_NEW_RESTART_CAPABILITY
   os <<         m_option_restartOutput_levelPeriod      << " = " << m_restartOutput_levelPeriod
      << "\n" << m_option_restartOutput_baseNameForFiles << " = " << m_restartOutput_baseNameForFiles
      << "\n" << m_option_restartOutput_fileType         << " = " << m_restartOutput_fileType
      << "\n" << m_option_restartInput_baseNameForFiles  << " = " << m_restartInput_baseNameForFiles
      << "\n" << m_option_restartInput_fileType          << " = " << m_restartInput_fileType
 #else
   os <<         m_option_restartInputFileName           << " = " << m_restartInputFileName
      << "\n" << m_option_restartInputFileType           << " = " << m_restartInputFileType
      << "\n" << m_option_restartChainSize               << " = " << m_restartChainSize
 #endif
      << "\n" << m_option_dataOutputFileName             << " = " << m_dataOutputFileName
      << "\n" << m_option_dataOutputAllowedSet           << " = ";
   for (std::set<unsigned int>::iterator setIt = m_dataOutputAllowedSet.begin(); setIt != m_dataOutputAllowedSet.end(); ++setIt) {
     os << *setIt << " ";
   }
   os << "\n";
 
   return;
 }

void QUESO::MLSamplingOptions::scanOptionsValues ( )

It scans the option values from the options input file.

Definition at line 71 of file MLSamplingOptions.C.

References defineMyOptions(), getMyOptionValues(), m_env, m_optionsDesc, m_prefix, QUESO::BaseEnvironment::scanInputFileForMyOptions(), and QUESO::BaseEnvironment::subDisplayFile().

Referenced by QUESO::MLSampling< P_V, P_M >::MLSampling().

 {
   defineMyOptions                (*m_optionsDesc);
   m_env.scanInputFileForMyOptions(*m_optionsDesc);
   getMyOptionValues              (*m_optionsDesc);
 
   if (m_env.subDisplayFile() != NULL) {
     *m_env.subDisplayFile() << "In MLSamplingOptions::scanOptionsValues()"
                             << ": after getting values of options with prefix '" << m_prefix
                             << "', state of object is:"
                             << "\n" << *this
                             << std::endl;
   }
 
   return;
 }