queso-0.57.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
QUESO::SfpOptionsValues Class Reference

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

#include <StatisticalForwardProblemOptions.h>

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
SfpOptionsValuesoperator= (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
 
std::string m_solverString
 

Private Member Functions

void copy (const SfpOptionsValues &src)
 Copies the option values from src to this. More...
 
void checkOptions ()
 

Private Attributes

BoostInputOptionsParserm_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
 
std::string m_option_solver
 

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 70 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.

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

Copy constructor.

It assigns the same options values from src to this.

Definition at line 139 of file StatisticalForwardProblemOptions.C.

References copy().

140 {
141  this->copy(src);
142 }
void copy(const SfpOptionsValues &src)
Copies the option values from src to this.
QUESO::SfpOptionsValues::~SfpOptionsValues ( )
virtual

Destructor.

Definition at line 144 of file StatisticalForwardProblemOptions.C.

145 {
146 }

Member Function Documentation

void QUESO::SfpOptionsValues::checkOptions ( )
private

Definition at line 156 of file StatisticalForwardProblemOptions.C.

157 {
158  // Do nothing
159 }
void QUESO::SfpOptionsValues::copy ( const SfpOptionsValues src)
private

Copies the option values from src to this.

Definition at line 163 of file StatisticalForwardProblemOptions.C.

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

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

164 {
165  m_computeSolution = src.m_computeSolution;
166  m_computeCovariances = src.m_computeCovariances;
167  m_computeCorrelations = src.m_computeCorrelations;
168  m_dataOutputFileName = src.m_dataOutputFileName;
169  m_dataOutputAllowedSet = src.m_dataOutputAllowedSet;
170 #ifdef UQ_SFP_READS_SOLVER_OPTION
171  m_solverString = src.m_solverString;
172 #endif
173 
174  //m_mcOptionsValues = src.m_mcOptionsValues;
175 
176  return;
177 }
std::set< unsigned int > m_dataOutputAllowedSet
SfpOptionsValues & QUESO::SfpOptionsValues::operator= ( const SfpOptionsValues rhs)

Assignment operator; it copies rhs to this.

Definition at line 149 of file StatisticalForwardProblemOptions.C.

References copy().

150 {
151  this->copy(rhs);
152  return *this;
153 }
void copy(const SfpOptionsValues &src)
Copies the option values from src to this.

Friends And Related Function Documentation

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

Definition at line 180 of file StatisticalForwardProblemOptions.C.

181 {
182 #ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
183  os << (*(obj.m_parser)) << std::endl;
184 #endif // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
185 
186  os << obj.m_option_computeSolution << " = " << obj.m_computeSolution
187  << "\n" << obj.m_option_computeCovariances << " = " << obj.m_computeCovariances
188  << "\n" << obj.m_option_computeCorrelations << " = " << obj.m_computeCorrelations
189  << "\n" << obj.m_option_dataOutputFileName << " = " << obj.m_dataOutputFileName;
190  os << "\n" << obj.m_option_dataOutputAllowedSet << " = ";
191  for (std::set<unsigned int>::iterator setIt = obj.m_dataOutputAllowedSet.begin(); setIt != obj.m_dataOutputAllowedSet.end(); ++setIt) {
192  os << *setIt << " ";
193  }
194 #ifdef UQ_SFP_READS_SOLVER_OPTION
195  << "\n" << obj.m_option_solver << " = " << obj.m_solverString
196 #endif
197  os << std::endl;
198  return os;
199 }

Member Data Documentation

bool QUESO::SfpOptionsValues::m_computeCorrelations

Definition at line 101 of file StatisticalForwardProblemOptions.h.

Referenced by copy(), and QUESO::operator<<().

bool QUESO::SfpOptionsValues::m_computeCovariances

Definition at line 100 of file StatisticalForwardProblemOptions.h.

Referenced by copy(), and QUESO::operator<<().

bool QUESO::SfpOptionsValues::m_computeSolution

Definition at line 99 of file StatisticalForwardProblemOptions.h.

Referenced by copy(), and QUESO::operator<<().

std::set<unsigned int> QUESO::SfpOptionsValues::m_dataOutputAllowedSet

Definition at line 103 of file StatisticalForwardProblemOptions.h.

Referenced by copy(), and QUESO::operator<<().

std::string QUESO::SfpOptionsValues::m_dataOutputFileName

Definition at line 102 of file StatisticalForwardProblemOptions.h.

Referenced by copy(), and QUESO::operator<<().

std::string QUESO::SfpOptionsValues::m_help

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

Definition at line 97 of file StatisticalForwardProblemOptions.h.

std::string QUESO::SfpOptionsValues::m_option_computeCorrelations
private

Definition at line 119 of file StatisticalForwardProblemOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::SfpOptionsValues::m_option_computeCovariances
private

Definition at line 118 of file StatisticalForwardProblemOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::SfpOptionsValues::m_option_computeSolution
private

Definition at line 117 of file StatisticalForwardProblemOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::SfpOptionsValues::m_option_dataOutputAllowedSet
private

Definition at line 121 of file StatisticalForwardProblemOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::SfpOptionsValues::m_option_dataOutputFileName
private

Definition at line 120 of file StatisticalForwardProblemOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::SfpOptionsValues::m_option_help
private

Definition at line 116 of file StatisticalForwardProblemOptions.h.

std::string QUESO::SfpOptionsValues::m_option_solver
private

Definition at line 123 of file StatisticalForwardProblemOptions.h.

Referenced by QUESO::operator<<().

BoostInputOptionsParser* QUESO::SfpOptionsValues::m_parser
private

Definition at line 112 of file StatisticalForwardProblemOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::SfpOptionsValues::m_prefix

Definition at line 94 of file StatisticalForwardProblemOptions.h.

std::string QUESO::SfpOptionsValues::m_solverString

Definition at line 105 of file StatisticalForwardProblemOptions.h.

Referenced by copy(), and QUESO::operator<<().


The documentation for this class was generated from the following files:

Generated on Tue Jun 5 2018 19:49:36 for queso-0.57.1 by  doxygen 1.8.5