This class provides options for a Statistical Forward Problem if no input file is available. More...

#include <StatisticalForwardProblemOptions.h>

Collaboration diagram for QUESO::SfpOptionsValues:

Public Member Functions

	SfpOptionsValues ()
	Constructor/Destructor methods. More...

	SfpOptionsValues (const BaseEnvironment env, const char prefix)

	SfpOptionsValues (const SfpOptionsValues &src)
	Copy constructor. More...

virtual	~SfpOptionsValues ()
	Destructor. More...

Set methods
SfpOptionsValues &	operator= (const SfpOptionsValues &rhs)
	Assignment operator; it copies `rhs` to `this`. More...

Public Attributes
std::string	m_prefix

std::string	m_help
	If non-empty string, options and values are printed to the output file. More...

bool	m_computeSolution

bool	m_computeCovariances

bool	m_computeCorrelations

std::string	m_dataOutputFileName

std::set< unsigned int >	m_dataOutputAllowedSet

Private Member Functions
void	copy (const SfpOptionsValues &src)
	Copies the option values from `src` to `this`. More...

void	checkOptions ()

Private Attributes
BoostInputOptionsParser *	m_parser

std::string	m_option_help

std::string	m_option_computeSolution

std::string	m_option_computeCovariances

std::string	m_option_computeCorrelations

std::string	m_option_dataOutputFileName

std::string	m_option_dataOutputAllowedSet

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

Detailed Description

This class provides options for a Statistical Forward Problem if no input file is available.

In order to solve a Statistical Forward Problem (SFP), QUESO expects some options for its methods to be fully defined. This class provides default values for such options if no input file is available.

Definition at line 69 of file StatisticalForwardProblemOptions.h.

Constructor & Destructor Documentation

QUESO::SfpOptionsValues::SfpOptionsValues ( )

Constructor/Destructor methods.

Default constructor.

Assigns the default suite of options to the Statistical Forward Problem.

Definition at line 40 of file StatisticalForwardProblemOptions.C.

   :
     m_prefix                     ("fp_"),
     m_help(UQ_SFP_HELP),
     m_computeSolution     (UQ_SFP_COMPUTE_SOLUTION_ODV     ),
     m_computeCovariances  (UQ_SFP_COMPUTE_COVARIANCES_ODV  ),
     m_computeCorrelations (UQ_SFP_COMPUTE_CORRELATIONS_ODV ),
     m_dataOutputFileName  (UQ_SFP_DATA_OUTPUT_FILE_NAME_ODV),
     //m_dataOutputAllowedSet(),
 #ifndef DISABLE_BOOST_PROGRAM_OPTIONS
     m_parser(NULL),
 #endif  // DISABLE_BOOST_PROGRAM_OPTIONS
     m_option_help                (m_prefix + "help"                ),
     m_option_computeSolution     (m_prefix + "computeSolution"     ),
     m_option_computeCovariances  (m_prefix + "computeCovariances"  ),
     m_option_computeCorrelations (m_prefix + "computeCorrelations" ),
     m_option_dataOutputFileName  (m_prefix + "dataOutputFileName"  ),
     m_option_dataOutputAllowedSet(m_prefix + "dataOutputAllowedSet")
 #ifdef UQ_SFP_READS_SOLVER_OPTION
     m_option_solver              (m_prefix + "solver"              ),
     m_solverString        (UQ_SFP_SOLVER_ODV               )
 #endif
 {
 }

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

Definition at line 65 of file StatisticalForwardProblemOptions.C.

References checkOptions(), QUESO::BoostInputOptionsParser::getOption(), QUESO::BaseEnvironment::input(), m_computeCorrelations, m_computeCovariances, m_computeSolution, m_dataOutputAllowedSet, m_dataOutputFileName, m_help, m_option_computeCorrelations, m_option_computeCovariances, m_option_computeSolution, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, m_parser, QUESO::BoostInputOptionsParser::registerOption(), QUESO::BoostInputOptionsParser::scanInputFile(), UQ_SFP_COMPUTE_CORRELATIONS_ODV, UQ_SFP_COMPUTE_COVARIANCES_ODV, UQ_SFP_COMPUTE_SOLUTION_ODV, UQ_SFP_DATA_OUTPUT_ALLOWED_SET_ODV, UQ_SFP_DATA_OUTPUT_FILE_NAME_ODV, UQ_SFP_HELP, and GetPot::vector_variable_size().

   :
     m_prefix                     ((std::string)(prefix) + "fp_"),
     m_help(UQ_SFP_HELP),
     m_computeSolution     (UQ_SFP_COMPUTE_SOLUTION_ODV     ),
     m_computeCovariances  (UQ_SFP_COMPUTE_COVARIANCES_ODV  ),
     m_computeCorrelations (UQ_SFP_COMPUTE_CORRELATIONS_ODV ),
     m_dataOutputFileName  (UQ_SFP_DATA_OUTPUT_FILE_NAME_ODV),
     //m_dataOutputAllowedSet(),
 #ifndef DISABLE_BOOST_PROGRAM_OPTIONS
     m_parser(new BoostInputOptionsParser(env->optionsInputFileName())),
 #endif  // DISABLE_BOOST_PROGRAM_OPTIONS
     m_option_help                (m_prefix + "help"                ),
     m_option_computeSolution     (m_prefix + "computeSolution"     ),
     m_option_computeCovariances  (m_prefix + "computeCovariances"  ),
     m_option_computeCorrelations (m_prefix + "computeCorrelations" ),
     m_option_dataOutputFileName  (m_prefix + "dataOutputFileName"  ),
     m_option_dataOutputAllowedSet(m_prefix + "dataOutputAllowedSet")
 #ifdef UQ_SFP_READS_SOLVER_OPTION
     m_option_solver              (m_prefix + "solver"              ),
     m_solverString        (UQ_SFP_SOLVER_ODV               )
 #endif
 {
 #ifndef DISABLE_BOOST_PROGRAM_OPTIONS
   m_parser->registerOption<std::string>(m_option_help,                 UQ_SFP_HELP,                        "produce help message for statistical forward problem");
   m_parser->registerOption<bool       >(m_option_computeSolution,      UQ_SFP_COMPUTE_SOLUTION_ODV       , "compute solution process"                            );
   m_parser->registerOption<bool       >(m_option_computeCovariances,   UQ_SFP_COMPUTE_COVARIANCES_ODV    , "compute pq covariances"                              );
   m_parser->registerOption<bool       >(m_option_computeCorrelations,  UQ_SFP_COMPUTE_CORRELATIONS_ODV   , "compute pq correlations"                             );
   m_parser->registerOption<std::string>(m_option_dataOutputFileName,   UQ_SFP_DATA_OUTPUT_FILE_NAME_ODV  , "name of data output file"                            );
   m_parser->registerOption<std::string>(m_option_dataOutputAllowedSet, UQ_SFP_DATA_OUTPUT_ALLOWED_SET_ODV, "subEnvs that will write to data output file"         );
 #ifdef UQ_SFP_READS_SOLVER_OPTION
   m_parser->registerOption<std::string>(m_option_solver,               UQ_SFP_SOLVER_ODV                 , "algorithm for propagation"                           );
 #endif
 
   m_parser->scanInputFile();
 
   m_parser->getOption<std::string>(m_option_help,                 m_help);
   m_parser->getOption<bool       >(m_option_computeSolution,      m_computeSolution);
   m_parser->getOption<bool       >(m_option_computeCovariances,   m_computeCovariances);
   m_parser->getOption<bool       >(m_option_computeCorrelations,  m_computeCorrelations);
   m_parser->getOption<std::string>(m_option_dataOutputFileName,   m_dataOutputFileName);
   m_parser->getOption<std::set<unsigned int> >(m_option_dataOutputAllowedSet, m_dataOutputAllowedSet);
 #ifdef UQ_SFP_READS_SOLVER_OPTION
   m_parser->getOption<std::string>(m_option_solver,               m_solver);
 #endif
 #else
   m_help = env->input()(m_option_help, UQ_SFP_HELP);
   m_computeSolution = env->input()(m_option_computeSolution, UQ_SFP_COMPUTE_SOLUTION_ODV);
   m_computeCovariances = env->input()(m_option_computeCovariances, UQ_SFP_COMPUTE_COVARIANCES_ODV);
   m_computeCorrelations = env->input()(m_option_computeCorrelations, UQ_SFP_COMPUTE_CORRELATIONS_ODV);
   m_dataOutputFileName = env->input()(m_option_dataOutputFileName, UQ_SFP_DATA_OUTPUT_FILE_NAME_ODV);
 
   // UQ_SFP_DATA_OUTPUT_ALLOWED_SET_ODV is the empty set (string) by default
   unsigned int size = env->input().vector_variable_size(m_option_dataOutputAllowedSet);
   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 = env->input()(m_option_dataOutputAllowedSet, i, i);
     m_dataOutputAllowedSet.insert(allowed);
   }
 
 #ifdef UQ_SFP_READS_SOLVER_OPTION
   m_solver = env->input()(m_option_solver, UQ_SFP_SOLVER_ODV);
 #endif
 #endif  // DISABLE_BOOST_PROGRAM_OPTIONS
 
   checkOptions();
 }

QUESO::SfpOptionsValues::SfpOptionsValues ( const SfpOptionsValues & src )

Copy constructor.

It assigns the same options values from src to this.

Definition at line 136 of file StatisticalForwardProblemOptions.C.

References copy().

 {
   this->copy(src);
 }

QUESO::SfpOptionsValues::~SfpOptionsValues ( )

virtual

Destructor.

Definition at line 141 of file StatisticalForwardProblemOptions.C.

142 {

143 }

Member Function Documentation

void QUESO::SfpOptionsValues::checkOptions ( )

private

Definition at line 153 of file StatisticalForwardProblemOptions.C.

Referenced by SfpOptionsValues().

 {
   // Do nothing
 }

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

private

Copies the option values from src to this.

Definition at line 160 of file StatisticalForwardProblemOptions.C.

References m_computeCorrelations, m_computeCovariances, m_computeSolution, m_dataOutputAllowedSet, and m_dataOutputFileName.

Referenced by operator=(), and SfpOptionsValues().

 {
   m_computeSolution      = src.m_computeSolution;
   m_computeCovariances   = src.m_computeCovariances;
   m_computeCorrelations  = src.m_computeCorrelations;
   m_dataOutputFileName   = src.m_dataOutputFileName;
   m_dataOutputAllowedSet = src.m_dataOutputAllowedSet;
 #ifdef UQ_SFP_READS_SOLVER_OPTION
   m_solverString         = src.m_solverString;
 #endif
 
   //m_mcOptionsValues      = src.m_mcOptionsValues;
 
   return;
 }

SfpOptionsValues & QUESO::SfpOptionsValues::operator= ( const SfpOptionsValues & rhs )

Assignment operator; it copies rhs to this.

Definition at line 146 of file StatisticalForwardProblemOptions.C.

References copy().

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

Friends And Related Function Documentation

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

friend

Definition at line 177 of file StatisticalForwardProblemOptions.C.

 {
 #ifndef DISABLE_BOOST_PROGRAM_OPTIONS
   os << (*(obj.m_parser)) << std::endl;
 #endif  // DISABLE_BOOST_PROGRAM_OPTIONS
 
   os <<         obj.m_option_computeSolution      << " = " << obj.m_computeSolution
      << "\n" << obj.m_option_computeCovariances   << " = " << obj.m_computeCovariances
      << "\n" << obj.m_option_computeCorrelations  << " = " << obj.m_computeCorrelations
      << "\n" << obj.m_option_dataOutputFileName   << " = " << obj.m_dataOutputFileName;
   os << "\n" << obj.m_option_dataOutputAllowedSet << " = ";
   for (std::set<unsigned int>::iterator setIt = obj.m_dataOutputAllowedSet.begin(); setIt != obj.m_dataOutputAllowedSet.end(); ++setIt) {
     os << *setIt << " ";
   }
 #ifdef UQ_SFP_READS_SOLVER_OPTION
        << "\n" << obj.m_option_solver << " = " << obj.m_solverString
 #endif
   os << std::endl;
   return os;
 }