queso-0.56.0
|
This class reads option values for a Statistical Forward Problem from an input file. More...
#include <StatisticalForwardProblemOptions.h>
Public Member Functions | |
Constructor/Destructor methods | |
StatisticalForwardProblemOptions (const BaseEnvironment &env, const char *prefix) | |
Constructor: reads options from the input file. More... | |
StatisticalForwardProblemOptions (const BaseEnvironment &env, const char *prefix, const SfpOptionsValues &alternativeOptionsValues) | |
Constructor: with alternative option values. More... | |
~StatisticalForwardProblemOptions () | |
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 | |
SfpOptionsValues | m_ov |
std::string | m_prefix |
Private Member Functions | |
void | defineMyOptions (boost::program_options::options_description &optionsDesc) const |
Define my SFP options as the default options. More... | |
void | getMyOptionValues (boost::program_options::options_description &optionsDesc) |
Gets the option values of the SFP. More... | |
Private Attributes | |
const BaseEnvironment & | m_env |
boost::program_options::options_description * | m_optionsDesc |
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 |
This class reads option values for a Statistical Forward Problem from an input file.
This class reads the option values for the Statistical Forward Problem (SFP) from an input file provided by the user. The class expects the prefix '<prefix>_fp_'. For instance, if 'prefix' is 'foo_775_', then the constructor will read all options that begin with 'foo_775_fp_'. If the options request data to be written in the output file (MATLAB .m format only, for now), the user can run 'grep zeros <OUTPUT FILE NAME>' after the solution procedure ends in order to check which MATLAB variables are defined and set. The names of the variables are self explanatory.
Definition at line 145 of file StatisticalForwardProblemOptions.h.
QUESO::StatisticalForwardProblemOptions::StatisticalForwardProblemOptions | ( | const BaseEnvironment & | env, |
const char * | prefix | ||
) |
Constructor: reads options from the input file.
Definition at line 203 of file StatisticalForwardProblemOptions.C.
References m_env, QUESO::BaseEnvironment::optionsInputFileName(), queso_deprecated, and queso_require_not_equal_to_msg.
QUESO::StatisticalForwardProblemOptions::StatisticalForwardProblemOptions | ( | const BaseEnvironment & | env, |
const char * | prefix, | ||
const SfpOptionsValues & | alternativeOptionsValues | ||
) |
Constructor: with alternative option values.
In this constructor, the input options are given by alternativeOptionsValues
, rather than the options input file
Definition at line 228 of file StatisticalForwardProblemOptions.C.
References m_env, m_prefix, QUESO::BaseEnvironment::optionsInputFileName(), queso_deprecated, queso_require_equal_to_msg, and QUESO::BaseEnvironment::subDisplayFile().
QUESO::StatisticalForwardProblemOptions::~StatisticalForwardProblemOptions | ( | ) |
Destructor.
Definition at line 262 of file StatisticalForwardProblemOptions.C.
References m_optionsDesc, and queso_deprecated.
|
private |
Define my SFP options as the default options.
Definition at line 320 of file StatisticalForwardProblemOptions.C.
References m_option_computeCorrelations, m_option_computeCovariances, m_option_computeSolution, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, queso_deprecated, UQ_SFP_COMPUTE_CORRELATIONS_ODV, UQ_SFP_COMPUTE_COVARIANCES_ODV, UQ_SFP_COMPUTE_SOLUTION_ODV, UQ_SFP_DATA_OUTPUT_ALLOWED_SET_ODV, and UQ_SFP_DATA_OUTPUT_FILE_NAME_ODV.
Referenced by scanOptionsValues().
|
private |
Gets the option values of the SFP.
Definition at line 343 of file StatisticalForwardProblemOptions.C.
References QUESO::BaseEnvironment::allOptionsMap(), QUESO::SfpOptionsValues::m_computeCorrelations, QUESO::SfpOptionsValues::m_computeCovariances, QUESO::SfpOptionsValues::m_computeSolution, QUESO::SfpOptionsValues::m_dataOutputAllowedSet, QUESO::SfpOptionsValues::m_dataOutputFileName, m_env, m_option_computeCorrelations, m_option_computeCovariances, m_option_computeSolution, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, m_ov, QUESO::MiscReadDoublesFromString(), queso_deprecated, and QUESO::BaseEnvironment::subDisplayFile().
Referenced by scanOptionsValues().
void QUESO::StatisticalForwardProblemOptions::print | ( | std::ostream & | os | ) | const |
It prints the option values.
Definition at line 297 of file StatisticalForwardProblemOptions.C.
References QUESO::SfpOptionsValues::m_computeCorrelations, QUESO::SfpOptionsValues::m_computeCovariances, QUESO::SfpOptionsValues::m_computeSolution, QUESO::SfpOptionsValues::m_dataOutputAllowedSet, QUESO::SfpOptionsValues::m_dataOutputFileName, m_option_computeCorrelations, m_option_computeCovariances, m_option_computeSolution, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_ov, and queso_deprecated.
Referenced by QUESO::operator<<().
void QUESO::StatisticalForwardProblemOptions::scanOptionsValues | ( | ) |
It scans the option values from the options input file.
Definition at line 273 of file StatisticalForwardProblemOptions.C.
References defineMyOptions(), getMyOptionValues(), m_env, m_optionsDesc, m_prefix, queso_deprecated, queso_require_msg, QUESO::BaseEnvironment::scanInputFileForMyOptions(), and QUESO::BaseEnvironment::subDisplayFile().
|
private |
Definition at line 183 of file StatisticalForwardProblemOptions.h.
Referenced by getMyOptionValues(), scanOptionsValues(), and StatisticalForwardProblemOptions().
|
private |
Definition at line 191 of file StatisticalForwardProblemOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 190 of file StatisticalForwardProblemOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 189 of file StatisticalForwardProblemOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 193 of file StatisticalForwardProblemOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 192 of file StatisticalForwardProblemOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 188 of file StatisticalForwardProblemOptions.h.
Referenced by defineMyOptions(), and getMyOptionValues().
|
private |
Definition at line 186 of file StatisticalForwardProblemOptions.h.
Referenced by scanOptionsValues(), and ~StatisticalForwardProblemOptions().
SfpOptionsValues QUESO::StatisticalForwardProblemOptions::m_ov |
Definition at line 171 of file StatisticalForwardProblemOptions.h.
Referenced by getMyOptionValues(), and print().
std::string QUESO::StatisticalForwardProblemOptions::m_prefix |
Definition at line 172 of file StatisticalForwardProblemOptions.h.
Referenced by scanOptionsValues(), and StatisticalForwardProblemOptions().