queso-0.52.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 (po::options_description &optionsDesc) const |
Define my SFP options as the default options. More... | |
void | getMyOptionValues (po::options_description &optionsDesc) |
Gets the option values of the SFP. More... | |
Private Attributes | |
const BaseEnvironment & | m_env |
po::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 107 of file StatisticalForwardProblemOptions.h.
QUESO::StatisticalForwardProblemOptions::StatisticalForwardProblemOptions | ( | const BaseEnvironment & | env, |
const char * | prefix | ||
) |
Constructor: reads options from the input file.
Definition at line 87 of file StatisticalForwardProblemOptions.C.
References m_env, QUESO::BaseEnvironment::optionsInputFileName(), UQ_FATAL_TEST_MACRO, and QUESO::BaseEnvironment::worldRank().
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 111 of file StatisticalForwardProblemOptions.C.
References m_env, m_prefix, QUESO::BaseEnvironment::optionsInputFileName(), QUESO::BaseEnvironment::subDisplayFile(), UQ_FATAL_TEST_MACRO, and QUESO::BaseEnvironment::worldRank().
QUESO::StatisticalForwardProblemOptions::~StatisticalForwardProblemOptions | ( | ) |
Destructor.
Definition at line 144 of file StatisticalForwardProblemOptions.C.
References m_optionsDesc.
|
private |
Define my SFP options as the default options.
Definition at line 194 of file StatisticalForwardProblemOptions.C.
References m_option_computeCorrelations, m_option_computeCovariances, m_option_computeSolution, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, 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 212 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(), and QUESO::BaseEnvironment::subDisplayFile().
Referenced by scanOptionsValues().
void QUESO::StatisticalForwardProblemOptions::print | ( | std::ostream & | os | ) | const |
It prints the option values.
Definition at line 174 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, and m_ov.
Referenced by QUESO::operator<<().
void QUESO::StatisticalForwardProblemOptions::scanOptionsValues | ( | ) |
It scans the option values from the options input file.
Definition at line 151 of file StatisticalForwardProblemOptions.C.
References defineMyOptions(), getMyOptionValues(), m_env, m_optionsDesc, m_prefix, QUESO::BaseEnvironment::scanInputFileForMyOptions(), QUESO::BaseEnvironment::subDisplayFile(), UQ_FATAL_TEST_MACRO, and QUESO::BaseEnvironment::worldRank().
|
private |
Definition at line 143 of file StatisticalForwardProblemOptions.h.
Referenced by getMyOptionValues(), scanOptionsValues(), and StatisticalForwardProblemOptions().
|
private |
Definition at line 149 of file StatisticalForwardProblemOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 148 of file StatisticalForwardProblemOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 147 of file StatisticalForwardProblemOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 151 of file StatisticalForwardProblemOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 150 of file StatisticalForwardProblemOptions.h.
Referenced by defineMyOptions(), getMyOptionValues(), and print().
|
private |
Definition at line 146 of file StatisticalForwardProblemOptions.h.
Referenced by defineMyOptions(), and getMyOptionValues().
|
private |
Definition at line 145 of file StatisticalForwardProblemOptions.h.
Referenced by scanOptionsValues(), and ~StatisticalForwardProblemOptions().
SfpOptionsValues QUESO::StatisticalForwardProblemOptions::m_ov |
Definition at line 133 of file StatisticalForwardProblemOptions.h.
Referenced by getMyOptionValues(), and print().
std::string QUESO::StatisticalForwardProblemOptions::m_prefix |
Definition at line 134 of file StatisticalForwardProblemOptions.h.
Referenced by scanOptionsValues(), and StatisticalForwardProblemOptions().