#include <SimulationModelOptions.h>

Collaboration diagram for QUESO::SimulationModelOptions:

Public Member Functions
	SimulationModelOptions (const BaseEnvironment &env, const char *prefix)

	SimulationModelOptions (const BaseEnvironment &env, const char *prefix, const SmOptionsValues &alternativeOptionsValues)

	~SimulationModelOptions ()

void	scanOptionsValues ()

void	print (std::ostream &os) const

Public Attributes
SmOptionsValues	m_ov

std::string	m_prefix

Private Member Functions
void	defineMyOptions (boost::program_options::options_description &optionsDesc) const

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

Private Attributes
const BaseEnvironment &	m_env

boost::program_options::options_description *	m_optionsDesc

std::string	m_option_help

std::string	m_option_dataOutputFileName

std::string	m_option_dataOutputAllowAll

std::string	m_option_dataOutputAllowedSet

std::string	m_option_p_eta

std::string	m_option_zeroRelativeSingularValue

std::string	m_option_cdfThresholdForPEta

std::string	m_option_a_w

std::string	m_option_b_w

std::string	m_option_a_rho_w

std::string	m_option_b_rho_w

std::string	m_option_a_eta

std::string	m_option_b_eta

std::string	m_option_a_s

std::string	m_option_b_s

Detailed Description

Definition at line 107 of file SimulationModelOptions.h.

Constructor & Destructor Documentation

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

Definition at line 275 of file SimulationModelOptions.C.

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

   :
   m_ov                              (),
   m_prefix                          ((std::string)(prefix) + "sm_"),
   m_env                             (env),
   m_optionsDesc                     (new boost::program_options::options_description("Simulation model options")),
   m_option_help                     (m_prefix + "help"                     ),
   m_option_dataOutputFileName       (m_prefix + "dataOutputFileName"       ),
   m_option_dataOutputAllowAll       (m_prefix + "dataOutputAllowAll"       ),
   m_option_dataOutputAllowedSet     (m_prefix + "dataOutputAllowedSet"     ),
   m_option_p_eta                    (m_prefix + "p_eta"                    ),
   m_option_zeroRelativeSingularValue(m_prefix + "zeroRelativeSingularValue"),
   m_option_cdfThresholdForPEta      (m_prefix + "cdfThresholdForPEta"      ),
   m_option_a_w                      (m_prefix + "a_w"                      ),
   m_option_b_w                      (m_prefix + "b_w"                      ),
   m_option_a_rho_w                  (m_prefix + "a_rho_w"                  ),
   m_option_b_rho_w                  (m_prefix + "b_rho_w"                  ),
   m_option_a_eta                    (m_prefix + "a_eta"                    ),
   m_option_b_eta                    (m_prefix + "b_eta"                    ),
   m_option_a_s                      (m_prefix + "a_s"                      ),
   m_option_b_s                      (m_prefix + "b_s"                      )
 {
   queso_require_not_equal_to_msg(m_env.optionsInputFileName(), "", "this constructor is incompatible with the abscense of an options input file");
 }

QUESO::SimulationModelOptions::SimulationModelOptions	(	const BaseEnvironment &	env,
		const char *	prefix,
		const SmOptionsValues &	alternativeOptionsValues
	)

Definition at line 302 of file SimulationModelOptions.C.

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

   :
   m_ov                              (alternativeOptionsValues),
   m_prefix                          ((std::string)(prefix) + "sm_"),
   m_env                             (env),
   m_optionsDesc                     (NULL),
   m_option_help                     (m_prefix + "help"                     ),
   m_option_dataOutputFileName       (m_prefix + "dataOutputFileName"       ),
   m_option_dataOutputAllowAll       (m_prefix + "dataOutputAllowAll"       ),
   m_option_dataOutputAllowedSet     (m_prefix + "dataOutputAllowedSet"     ),
   m_option_p_eta                    (m_prefix + "p_eta"                    ),
   m_option_zeroRelativeSingularValue(m_prefix + "zeroRelativeSingularValue"),
   m_option_cdfThresholdForPEta      (m_prefix + "cdfThresholdForPEta"      ),
   m_option_a_w                      (m_prefix + "a_w"                      ),
   m_option_b_w                      (m_prefix + "b_w"                      ),
   m_option_a_rho_w                  (m_prefix + "a_rho_w"                  ),
   m_option_b_rho_w                  (m_prefix + "b_rho_w"                  ),
   m_option_a_eta                    (m_prefix + "a_eta"                    ),
   m_option_b_eta                    (m_prefix + "b_eta"                    ),
   m_option_a_s                      (m_prefix + "a_s"                      ),
   m_option_b_s                      (m_prefix + "b_s"                      )
 {
   queso_deprecated();
 
   queso_require_equal_to_msg(m_env.optionsInputFileName(), "", "this constructor is incompatible with the existence of an options input file");
 
   if (m_env.subDisplayFile() != NULL) {
     *m_env.subDisplayFile() << "In SimulationModelOptions::constructor(2)"
                             << ": after setting values of options with prefix '" << m_prefix
                             << "', state of object is:"
                             << "\n" << *this
                             << std::endl;
   }
 }

QUESO::SimulationModelOptions::~SimulationModelOptions ( )

Definition at line 340 of file SimulationModelOptions.C.

References m_optionsDesc, and queso_deprecated.

 {
   queso_deprecated();
 
   if (m_optionsDesc) delete m_optionsDesc;
 }

Member Function Documentation

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

private

Definition at line 374 of file SimulationModelOptions.C.

Referenced by scanOptionsValues().

 {
   queso_deprecated();
 
   optionsDesc.add_options()
     (m_option_help.c_str(),                                                                                                                      "produce help message for simulation model options")
     (m_option_dataOutputFileName.c_str(),        boost::program_options::value<std::string >()->default_value(UQ_SIMULATION_MODEL_DATA_OUTPUT_FILE_NAME_ODV       ), "name of data output file"                         )
     (m_option_dataOutputAllowAll.c_str(),        boost::program_options::value<bool        >()->default_value(UQ_SIMULATION_MODEL_DATA_OUTPUT_ALLOW_ALL_ODV       ), "allow all or not"                                 )
     (m_option_dataOutputAllowedSet.c_str(),      boost::program_options::value<std::string >()->default_value(UQ_SIMULATION_MODEL_DATA_OUTPUT_ALLOWED_SET_ODV     ), "subEnvs that will write to data output file"      )
     (m_option_p_eta.c_str(),                     boost::program_options::value<unsigned int>()->default_value(UQ_SIMULATION_MODEL_P_ETA_ODV                       ), "p_eta"                                            )
     (m_option_zeroRelativeSingularValue.c_str(), boost::program_options::value<double      >()->default_value(UQ_SIMULATION_MODEL_ZERO_RELATIVE_SINGULAR_VALUE_ODV), "zeroRelativeSingularValue"                        )
     (m_option_cdfThresholdForPEta.c_str(),       boost::program_options::value<double      >()->default_value(UQ_SIMULATION_MODEL_CDF_THRESHOLD_FOR_P_ETA_ODV     ), "cdfThresholdForPEta"                              )
     (m_option_a_w.c_str(),                       boost::program_options::value<double      >()->default_value(UQ_SIMULATION_MODEL_A_W_ODV                         ), "a_w"                                              )
     (m_option_b_w.c_str(),                       boost::program_options::value<double      >()->default_value(UQ_SIMULATION_MODEL_B_W_ODV                         ), "b_w"                                              )
     (m_option_a_rho_w.c_str(),                   boost::program_options::value<double      >()->default_value(UQ_SIMULATION_MODEL_A_RHO_W_ODV                     ), "a_rho_w"                                          )
     (m_option_b_rho_w.c_str(),                   boost::program_options::value<double      >()->default_value(UQ_SIMULATION_MODEL_B_RHO_W_ODV                     ), "b_rho_w"                                          )
     (m_option_a_eta.c_str(),                     boost::program_options::value<double      >()->default_value(UQ_SIMULATION_MODEL_A_ETA_ODV                       ), "a_eta"                                            )
     (m_option_b_eta.c_str(),                     boost::program_options::value<double      >()->default_value(UQ_SIMULATION_MODEL_B_ETA_ODV                       ), "b_eta"                                            )
     (m_option_a_s.c_str(),                       boost::program_options::value<double      >()->default_value(UQ_SIMULATION_MODEL_A_S_ODV                         ), "a_s"                                              )
     (m_option_b_s.c_str(),                       boost::program_options::value<double      >()->default_value(UQ_SIMULATION_MODEL_B_S_ODV                         ), "b_s"                                              )
   ;
 
   return;
 }

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

private

Definition at line 400 of file SimulationModelOptions.C.

Referenced by scanOptionsValues().

 {
   if (m_env.allOptionsMap().count(m_option_help)) {
     if (m_env.subDisplayFile()) {
       *m_env.subDisplayFile() << optionsDesc
                               << std::endl;
     }
   }
 
   if (m_env.allOptionsMap().count(m_option_dataOutputFileName)) {
     m_ov.m_dataOutputFileName = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_dataOutputFileName]).as<std::string>();
   }
 
   if (m_env.allOptionsMap().count(m_option_dataOutputAllowAll)) {
     m_ov.m_dataOutputAllowAll = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_dataOutputAllowAll]).as<bool>();
   }
 
   if (m_ov.m_dataOutputAllowAll) {
     m_ov.m_dataOutputAllowedSet.insert(m_env.subId());
   }
   else if (m_env.allOptionsMap().count(m_option_dataOutputAllowedSet)) {
     m_ov.m_dataOutputAllowedSet.clear();
     std::vector<double> tmpAllow(0,0.);
     std::string inputString = m_env.allOptionsMap()[m_option_dataOutputAllowedSet].as<std::string>();
     MiscReadDoublesFromString(inputString,tmpAllow);
 
     if (tmpAllow.size() > 0) {
       for (unsigned int i = 0; i < tmpAllow.size(); ++i) {
         m_ov.m_dataOutputAllowedSet.insert((unsigned int) tmpAllow[i]);
       }
     }
   }
 
   if (m_env.allOptionsMap().count(m_option_p_eta)) {
     m_ov.m_p_eta = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_p_eta]).as<unsigned int>();
   }
 
   if (m_env.allOptionsMap().count(m_option_zeroRelativeSingularValue)) {
     m_ov.m_zeroRelativeSingularValue = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_zeroRelativeSingularValue]).as<double>();
   }
 
   if (m_env.allOptionsMap().count(m_option_cdfThresholdForPEta)) {
     m_ov.m_cdfThresholdForPEta = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_cdfThresholdForPEta]).as<double>();
   }
 
   if (m_env.allOptionsMap().count(m_option_a_w)) {
     m_ov.m_a_w = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_a_w]).as<double>();
   }
 
   if (m_env.allOptionsMap().count(m_option_b_w)) {
     m_ov.m_b_w = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_b_w]).as<double>();
   }
 
   if (m_env.allOptionsMap().count(m_option_a_rho_w)) {
     m_ov.m_a_rho_w = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_a_rho_w]).as<double>();
   }
 
   if (m_env.allOptionsMap().count(m_option_b_rho_w)) {
     m_ov.m_b_rho_w = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_b_rho_w]).as<double>();
   }
 
   if (m_env.allOptionsMap().count(m_option_a_eta)) {
     m_ov.m_a_eta = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_a_eta]).as<double>();
   }
 
   if (m_env.allOptionsMap().count(m_option_b_eta)) {
     m_ov.m_b_eta = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_b_eta]).as<double>();
   }
 
   if (m_env.allOptionsMap().count(m_option_a_s)) {
     m_ov.m_a_s = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_a_s]).as<double>();
   }
 
   if (m_env.allOptionsMap().count(m_option_b_s)) {
     m_ov.m_b_s = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_b_s]).as<double>();
   }
 
   return;
 }

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

Definition at line 481 of file SimulationModelOptions.C.

Referenced by QUESO::operator<<().

 {
   queso_deprecated();
 
   os << "\n" << m_option_dataOutputFileName        << " = " << m_ov.m_dataOutputFileName
      << "\n" << m_option_dataOutputAllowAll        << " = " << m_ov.m_dataOutputAllowAll
      << "\n" << m_option_dataOutputAllowedSet      << " = ";
   for (std::set<unsigned int>::iterator setIt = m_ov.m_dataOutputAllowedSet.begin(); setIt != m_ov.m_dataOutputAllowedSet.end(); ++setIt) {
     os << *setIt << " ";
   }
   os << "\n" << m_option_p_eta                     << " = " << m_ov.m_p_eta
      << "\n" << m_option_zeroRelativeSingularValue << " = " << m_ov.m_zeroRelativeSingularValue
      << "\n" << m_option_cdfThresholdForPEta       << " = " << m_ov.m_cdfThresholdForPEta
      << "\n" << m_option_a_w                       << " = " << m_ov.m_a_w
      << "\n" << m_option_b_w                       << " = " << m_ov.m_b_w
      << "\n" << m_option_a_rho_w                   << " = " << m_ov.m_a_rho_w
      << "\n" << m_option_b_rho_w                   << " = " << m_ov.m_b_rho_w
      << "\n" << m_option_a_eta                     << " = " << m_ov.m_a_eta
      << "\n" << m_option_b_eta                     << " = " << m_ov.m_b_eta
      << "\n" << m_option_a_s                       << " = " << m_ov.m_a_s
      << "\n" << m_option_b_s                       << " = " << m_ov.m_b_s
      << std::endl;
 
   return;
 }

void QUESO::SimulationModelOptions::scanOptionsValues ( )

Definition at line 348 of file SimulationModelOptions.C.

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

 {
   queso_deprecated();
 
   queso_require_msg(m_optionsDesc, "m_optionsDesc variable is NULL");
 
   defineMyOptions                (*m_optionsDesc);
   m_env.scanInputFileForMyOptions(*m_optionsDesc);
   //std::cout << "scan 000\n"
   //          << std::endl;
   getMyOptionValues              (*m_optionsDesc);
   //std::cout << "scan 001\n"
   //          << std::endl;
 
   if (m_env.subDisplayFile() != NULL) {
     *m_env.subDisplayFile() << "In SimulationModelOptions::scanOptionsValues()"
                             << ": after reading values of options with prefix '" << m_prefix
                             << "', state of  object is:"
                             << "\n" << *this
                             << std::endl;
   }
 
   return;
 }