This class defines the options that specify the behaviour of the Gaussian process emulator. More...

#include <GPMSAOptions.h>

Collaboration diagram for QUESO::GPMSAOptions:

Public Member Functions
	GPMSAOptions (const BaseEnvironment &env, const char *prefix)
	Given prefix, read the input file for parameters named prefix_*. More...

virtual	~GPMSAOptions ()
	Destructor. More...

void	print (std::ostream &os) const
	Prints `this` to `os`. More...

const BaseEnvironment &	env () const
	Returns the QUESO environment. More...

Public Attributes
std::string	m_prefix
	The prefix to look for in the input file. More...

std::string	m_help
	If this string is non-empty, print the options object to the output file. More...

double	m_emulatorPrecisionShape
	The shape parameter for the Gamma hyperprior for the emulator precision. More...

double	m_emulatorPrecisionScale
	The scale parameter for the Gamma hyperprior for the emulator precision. More...

double	m_emulatorCorrelationStrengthAlpha
	The alpha paramter for the Beta hyperprior for the emulator correlation strength. More...

double	m_emulatorCorrelationStrengthBeta
	The beta paramter for the Beta hyperprior for the emulator correlation strength. More...

double	m_discrepancyPrecisionShape
	The shape parameter for the Gamma hyperprior for the discrepancy precision. More...

double	m_discrepancyPrecisionScale
	The scale parameter for the Gamma hyperprior for the discrepancy precision. More...

double	m_discrepancyCorrelationStrengthAlpha
	The alpha paramter for the Beta hyperprior for the discrepancy correlation strength. More...

double	m_discrepancyCorrelationStrengthBeta
	The beta paramter for the Beta hyperprior for the discrepancy correlation strength. More...

double	m_emulatorDataPrecisionShape
	The shape parameter for the Gamma hyperprior for the emulator data precision. More...

double	m_emulatorDataPrecisionScale
	The scale parameter for the Gamma hyperprior for the emulator data precision. More...

Private Member Functions
void	checkOptions ()

Private Attributes
const BaseEnvironment &	m_env

BoostInputOptionsParser *	m_parser

std::string	m_option_help

std::string	m_option_emulatorPrecisionShape

std::string	m_option_emulatorPrecisionScale

std::string	m_option_emulatorCorrelationStrengthAlpha

std::string	m_option_emulatorCorrelationStrengthBeta

std::string	m_option_discrepancyPrecisionShape

std::string	m_option_discrepancyPrecisionScale

std::string	m_option_discrepancyCorrelationStrengthAlpha

std::string	m_option_discrepancyCorrelationStrengthBeta

std::string	m_option_emulatorDataPrecisionShape

std::string	m_option_emulatorDataPrecisionScale

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

Detailed Description

This class defines the options that specify the behaviour of the Gaussian process emulator.

Definition at line 40 of file GPMSAOptions.h.

Constructor & Destructor Documentation

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

Given prefix, read the input file for parameters named prefix_*.

Definition at line 44 of file GPMSAOptions.C.

References checkOptions(), QUESO::BoostInputOptionsParser::getOption(), m_discrepancyCorrelationStrengthAlpha, m_discrepancyCorrelationStrengthBeta, m_discrepancyPrecisionScale, m_discrepancyPrecisionShape, m_emulatorCorrelationStrengthAlpha, m_emulatorCorrelationStrengthBeta, m_emulatorDataPrecisionScale, m_emulatorDataPrecisionShape, m_emulatorPrecisionScale, m_emulatorPrecisionShape, m_env, m_help, m_option_discrepancyCorrelationStrengthAlpha, m_option_discrepancyCorrelationStrengthBeta, m_option_discrepancyPrecisionScale, m_option_discrepancyPrecisionShape, m_option_emulatorCorrelationStrengthAlpha, m_option_emulatorCorrelationStrengthBeta, m_option_emulatorDataPrecisionScale, m_option_emulatorDataPrecisionShape, m_option_emulatorPrecisionScale, m_option_emulatorPrecisionShape, m_option_help, m_parser, QUESO::BaseEnvironment::optionsInputFileName(), queso_error_msg, QUESO::BoostInputOptionsParser::registerOption(), QUESO::BoostInputOptionsParser::scanInputFile(), UQ_GPMSA_DISCREPANCY_CORRELATION_STRENGTH_ALPHA_ODV, UQ_GPMSA_DISCREPANCY_CORRELATION_STRENGTH_BETA_ODV, UQ_GPMSA_DISCREPANCY_PRECISION_SCALE_ODV, UQ_GPMSA_DISCREPANCY_PRECISION_SHAPE_ODV, UQ_GPMSA_EMULATOR_CORRELATION_STRENGTH_ALPHA_ODV, UQ_GPMSA_EMULATOR_CORRELATION_STRENGTH_BETA_ODV, UQ_GPMSA_EMULATOR_DATA_PRECISION_SCALE_ODV, UQ_GPMSA_EMULATOR_DATA_PRECISION_SHAPE_ODV, UQ_GPMSA_EMULATOR_PRECISION_SCALE_ODV, UQ_GPMSA_EMULATOR_PRECISION_SHAPE_ODV, and UQ_GPMSA_HELP.

   :
   m_prefix((std::string)(prefix) + "gpmsa_"),
   m_help(UQ_GPMSA_HELP),
   m_emulatorPrecisionShape(UQ_GPMSA_EMULATOR_PRECISION_SHAPE_ODV),
   m_emulatorPrecisionScale(UQ_GPMSA_EMULATOR_PRECISION_SCALE_ODV),
   m_emulatorCorrelationStrengthAlpha(UQ_GPMSA_EMULATOR_CORRELATION_STRENGTH_ALPHA_ODV),
   m_emulatorCorrelationStrengthBeta(UQ_GPMSA_EMULATOR_CORRELATION_STRENGTH_BETA_ODV),
   m_discrepancyPrecisionShape(UQ_GPMSA_DISCREPANCY_PRECISION_SHAPE_ODV),
   m_discrepancyPrecisionScale(UQ_GPMSA_DISCREPANCY_PRECISION_SCALE_ODV),
   m_discrepancyCorrelationStrengthAlpha(UQ_GPMSA_DISCREPANCY_CORRELATION_STRENGTH_ALPHA_ODV),
   m_discrepancyCorrelationStrengthBeta(UQ_GPMSA_DISCREPANCY_CORRELATION_STRENGTH_BETA_ODV),
   m_emulatorDataPrecisionShape(UQ_GPMSA_EMULATOR_DATA_PRECISION_SHAPE_ODV),
   m_emulatorDataPrecisionScale(UQ_GPMSA_EMULATOR_DATA_PRECISION_SCALE_ODV),
   m_env(env),
   m_parser(new BoostInputOptionsParser(env.optionsInputFileName())),
   m_option_help(m_prefix + "help"),
   m_option_emulatorPrecisionShape(m_prefix + "emulator_precision_shape"),
   m_option_emulatorPrecisionScale(m_prefix + "emulator_precision_scale"),
   m_option_emulatorCorrelationStrengthAlpha(m_prefix + "emulator_correlation_strength_alpha"),
   m_option_emulatorCorrelationStrengthBeta(m_prefix + "emulator_correlation_strength_beta"),
   m_option_discrepancyPrecisionShape(m_prefix + "discrepancy_precision_shape"),
   m_option_discrepancyPrecisionScale(m_prefix + "discrepancy_precision_scale"),
   m_option_discrepancyCorrelationStrengthAlpha(m_prefix + "discrepancy_correlation_strength_alpha"),
   m_option_discrepancyCorrelationStrengthBeta(m_prefix + "discrepancy_correlation_strength_beta"),
   m_option_emulatorDataPrecisionShape(m_prefix + "emulator_data_precision_shape"),
   m_option_emulatorDataPrecisionScale(m_prefix + "emulator_data_precision_scale")
 {
   if (m_env.optionsInputFileName() == "") {
     queso_error_msg("Missing input file is required");
   }
 
   m_parser->registerOption<std::string>(m_option_help, UQ_GPMSA_HELP, "produce help message Gaussian process emulator");
   m_parser->registerOption<double>(m_option_emulatorPrecisionShape, UQ_GPMSA_EMULATOR_PRECISION_SHAPE_ODV, "shape hyperprior (Gamma) parameter for emulator precision");
   m_parser->registerOption<double>(m_option_emulatorPrecisionScale, UQ_GPMSA_EMULATOR_PRECISION_SCALE_ODV, "scale hyperprior (Gamma) parameter for emulator precision");
   m_parser->registerOption<double>(m_option_emulatorCorrelationStrengthAlpha, UQ_GPMSA_EMULATOR_CORRELATION_STRENGTH_ALPHA_ODV, "alpha hyperprior (Beta) parameter for emulator correlation strength");
   m_parser->registerOption<double>(m_option_emulatorCorrelationStrengthBeta, UQ_GPMSA_EMULATOR_CORRELATION_STRENGTH_BETA_ODV, "beta hyperprior (Beta) parameter for emulator correlation strength");
   m_parser->registerOption<double>(m_option_discrepancyPrecisionShape, UQ_GPMSA_DISCREPANCY_PRECISION_SHAPE_ODV, "shape hyperprior (Gamma) parameter for discrepancy precision");
   m_parser->registerOption<double>(m_option_discrepancyPrecisionScale, UQ_GPMSA_DISCREPANCY_PRECISION_SCALE_ODV, "scale hyperprior (Gamma) parameter for discrepancy precision");
   m_parser->registerOption<double>(m_option_discrepancyCorrelationStrengthAlpha, UQ_GPMSA_DISCREPANCY_CORRELATION_STRENGTH_ALPHA_ODV, "alpha hyperprior (Beta) parameter for discrepancy correlation strength");
   m_parser->registerOption<double>(m_option_discrepancyCorrelationStrengthBeta, UQ_GPMSA_DISCREPANCY_CORRELATION_STRENGTH_BETA_ODV, "beta hyperprior (Beta) parameter for discrepancy correlation strength");
   m_parser->registerOption<double>(m_option_emulatorDataPrecisionShape, UQ_GPMSA_EMULATOR_DATA_PRECISION_SHAPE_ODV, "shape hyperprior (Gamma) parameter for emulator data precision");
   m_parser->registerOption<double>(m_option_emulatorDataPrecisionScale, UQ_GPMSA_EMULATOR_DATA_PRECISION_SCALE_ODV, "scale hyperprior (Gamma) parameter for emulator data precision");
 
   m_parser->scanInputFile();
 
   m_parser->getOption<std::string>(m_option_help,                           m_help);
   m_parser->getOption<double>(m_option_emulatorPrecisionShape,              m_emulatorPrecisionShape);
   m_parser->getOption<double>(m_option_emulatorPrecisionScale,              m_emulatorPrecisionScale);
   m_parser->getOption<double>(m_option_emulatorCorrelationStrengthAlpha,    m_emulatorCorrelationStrengthAlpha);
   m_parser->getOption<double>(m_option_emulatorCorrelationStrengthBeta,     m_emulatorCorrelationStrengthBeta);
   m_parser->getOption<double>(m_option_discrepancyPrecisionShape,           m_discrepancyPrecisionShape);
   m_parser->getOption<double>(m_option_discrepancyPrecisionScale,           m_discrepancyPrecisionScale);
   m_parser->getOption<double>(m_option_discrepancyCorrelationStrengthAlpha, m_discrepancyCorrelationStrengthAlpha);
   m_parser->getOption<double>(m_option_discrepancyCorrelationStrengthBeta,  m_discrepancyCorrelationStrengthBeta);
   m_parser->getOption<double>(m_option_emulatorDataPrecisionShape,          m_emulatorDataPrecisionShape);
   m_parser->getOption<double>(m_option_emulatorDataPrecisionScale,          m_emulatorDataPrecisionScale);
 
   checkOptions();
 }

QUESO::GPMSAOptions::~GPMSAOptions ( )

virtual

Destructor.

Definition at line 107 of file GPMSAOptions.C.

108 {

109 }

Member Function Documentation

void QUESO::GPMSAOptions::checkOptions ( )

private

Definition at line 112 of file GPMSAOptions.C.

References m_env, m_help, and QUESO::BaseEnvironment::subDisplayFile().

Referenced by GPMSAOptions().

 {
   if (m_help != "") {
     if (m_env.subDisplayFile()) {
       *m_env.subDisplayFile() << (*this) << std::endl;
     }
   }
 }

const BaseEnvironment& QUESO::GPMSAOptions::env ( ) const

Returns the QUESO environment.

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

Prints this to os.

Definition at line 122 of file GPMSAOptions.C.

References m_discrepancyCorrelationStrengthAlpha, m_discrepancyCorrelationStrengthBeta, m_discrepancyPrecisionScale, m_discrepancyPrecisionShape, m_emulatorCorrelationStrengthAlpha, m_emulatorCorrelationStrengthBeta, m_emulatorDataPrecisionScale, m_emulatorDataPrecisionShape, m_emulatorPrecisionScale, m_emulatorPrecisionShape, m_option_discrepancyCorrelationStrengthAlpha, m_option_discrepancyCorrelationStrengthBeta, m_option_discrepancyPrecisionScale, m_option_discrepancyPrecisionShape, m_option_emulatorCorrelationStrengthAlpha, m_option_emulatorCorrelationStrengthBeta, m_option_emulatorDataPrecisionScale, m_option_emulatorDataPrecisionShape, m_option_emulatorPrecisionScale, and m_option_emulatorPrecisionShape.

Referenced by QUESO::operator<<().

 {
   os << "\n" << m_option_emulatorPrecisionShape << " = " << this->m_emulatorPrecisionShape
      << "\n" << m_option_emulatorPrecisionScale << " = " << this->m_emulatorPrecisionScale
      << "\n" << m_option_emulatorCorrelationStrengthAlpha << " = " << this->m_emulatorCorrelationStrengthAlpha
      << "\n" << m_option_emulatorCorrelationStrengthBeta << " = " << this->m_emulatorCorrelationStrengthBeta
      << "\n" << m_option_discrepancyPrecisionShape << " = " << this->m_discrepancyPrecisionShape
      << "\n" << m_option_discrepancyPrecisionScale << " = " << this->m_discrepancyPrecisionScale
      << "\n" << m_option_discrepancyCorrelationStrengthAlpha << " = " << this->m_discrepancyCorrelationStrengthAlpha
      << "\n" << m_option_discrepancyCorrelationStrengthBeta << " = " << this->m_discrepancyCorrelationStrengthBeta
      << "\n" << m_option_emulatorDataPrecisionShape << " = " << this->m_emulatorDataPrecisionShape
      << "\n" << m_option_emulatorDataPrecisionScale << " = " << this->m_emulatorDataPrecisionScale
      << std::endl;
 }

Friends And Related Function Documentation

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

friend

Definition at line 138 of file GPMSAOptions.C.

 {
   os << (*(obj.m_parser)) << std::endl;
   obj.print(os);
   return os;
 }

Member Data Documentation

double QUESO::GPMSAOptions::m_discrepancyCorrelationStrengthAlpha

The alpha paramter for the Beta hyperprior for the discrepancy correlation strength.

Definition at line 77 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

double QUESO::GPMSAOptions::m_discrepancyCorrelationStrengthBeta

The beta paramter for the Beta hyperprior for the discrepancy correlation strength.

Definition at line 80 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

double QUESO::GPMSAOptions::m_discrepancyPrecisionScale

The scale parameter for the Gamma hyperprior for the discrepancy precision.

Definition at line 74 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

double QUESO::GPMSAOptions::m_discrepancyPrecisionShape

The shape parameter for the Gamma hyperprior for the discrepancy precision.

Definition at line 71 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

double QUESO::GPMSAOptions::m_emulatorCorrelationStrengthAlpha

The alpha paramter for the Beta hyperprior for the emulator correlation strength.

Definition at line 65 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

double QUESO::GPMSAOptions::m_emulatorCorrelationStrengthBeta

The beta paramter for the Beta hyperprior for the emulator correlation strength.

Definition at line 68 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

double QUESO::GPMSAOptions::m_emulatorDataPrecisionScale

The scale parameter for the Gamma hyperprior for the emulator data precision.

Definition at line 89 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

double QUESO::GPMSAOptions::m_emulatorDataPrecisionShape

The shape parameter for the Gamma hyperprior for the emulator data precision.

Definition at line 86 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

double QUESO::GPMSAOptions::m_emulatorPrecisionScale

The scale parameter for the Gamma hyperprior for the emulator precision.

Definition at line 62 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

double QUESO::GPMSAOptions::m_emulatorPrecisionShape

The shape parameter for the Gamma hyperprior for the emulator precision.

Definition at line 59 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

const BaseEnvironment& QUESO::GPMSAOptions::m_env

private

Definition at line 94 of file GPMSAOptions.h.

Referenced by checkOptions(), and GPMSAOptions().

std::string QUESO::GPMSAOptions::m_help

If this string is non-empty, print the options object to the output file.

Definition at line 56 of file GPMSAOptions.h.

Referenced by checkOptions(), and GPMSAOptions().

std::string QUESO::GPMSAOptions::m_option_discrepancyCorrelationStrengthAlpha

private

Definition at line 105 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

std::string QUESO::GPMSAOptions::m_option_discrepancyCorrelationStrengthBeta

private

Definition at line 106 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

std::string QUESO::GPMSAOptions::m_option_discrepancyPrecisionScale

private

Definition at line 104 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

std::string QUESO::GPMSAOptions::m_option_discrepancyPrecisionShape

private

Definition at line 103 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

std::string QUESO::GPMSAOptions::m_option_emulatorCorrelationStrengthAlpha

private

Definition at line 101 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

std::string QUESO::GPMSAOptions::m_option_emulatorCorrelationStrengthBeta

private

Definition at line 102 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

std::string QUESO::GPMSAOptions::m_option_emulatorDataPrecisionScale

private

Definition at line 108 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

std::string QUESO::GPMSAOptions::m_option_emulatorDataPrecisionShape

private

Definition at line 107 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

std::string QUESO::GPMSAOptions::m_option_emulatorPrecisionScale

private

Definition at line 100 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

std::string QUESO::GPMSAOptions::m_option_emulatorPrecisionShape

private

Definition at line 99 of file GPMSAOptions.h.

Referenced by GPMSAOptions(), and print().

std::string QUESO::GPMSAOptions::m_option_help

private

Definition at line 98 of file GPMSAOptions.h.

Referenced by GPMSAOptions().

BoostInputOptionsParser* QUESO::GPMSAOptions::m_parser

private

Definition at line 96 of file GPMSAOptions.h.

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

std::string QUESO::GPMSAOptions::m_prefix

The prefix to look for in the input file.

Definition at line 53 of file GPMSAOptions.h.

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

src/gp/inc/GPMSAOptions.h
src/gp/src/GPMSAOptions.C

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation