A class used to generate a Gaussian likelihood of observing model predictions. More...

#include <Gaussian.h>

Inheritance diagram for Gaussian:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	Gaussian (const InputParameters &parameters)

virtual Real	function (const std::vector< Real > &x) const override
	Return the probability density or mass function at vector x. More...

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject (IsKokkosObjectKey &&) const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static Real	function (const std::vector< Real > &exp, const std::vector< Real > &model, const Real &noise, const bool &log_likelihood)
	Return the probability density function. More...

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

Protected Member Functions
void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

const ReporterContextBase &	getReporterContextBaseByName (const ReporterName &reporter_name) const

const ReporterName &	getReporterName (const std::string &param_name) const

virtual void	addReporterDependencyHelper (const ReporterName &)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

Protected Attributes
const bool	_log_likelihood
	return log-likelihood or likelihood More...

const Real &	_noise
	Noise value. More...

std::vector< Real >	_exp_values
	Experimental data values. More...

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const Parallel::Communicator &	_communicator

Detailed Description

A class used to generate a Gaussian likelihood of observing model predictions.

Definition at line 18 of file Gaussian.h.

Constructor & Destructor Documentation

◆ Gaussian()

Gaussian::Gaussian ( const InputParameters & parameters )

Definition at line 33 of file Gaussian.C.

   : LikelihoodFunctionBase(parameters),
     ReporterInterface(this),
     _log_likelihood(getParam<bool>("log_likelihood")),
     _noise(getReporterValue<Real>("noise"))
 {
   if (isParamValid("exp_values") && isParamValid("file_name"))
     paramError("exp_values", "exp_values and file_name both cannot be set at the same time.");
   else if (isParamValid("file_name"))
   {
     MooseUtils::DelimitedFileReader reader(getParam<FileName>("file_name"));
     reader.read();
     if (isParamValid("file_column_name"))
       _exp_values = reader.getData(getParam<std::string>("file_column_name"));
     else
       _exp_values = reader.getData(0);
   }
   else if (isParamValid("exp_values"))
     _exp_values = getParam<std::vector<Real>>("exp_values");
   else
     mooseError("Either 'exp_values' or 'file_name' parameters must be specified to represent "
                "experimental data.");
 }

Member Function Documentation

◆ function() [1/2]

Real Gaussian::function ( const std::vector< Real > & x ) const

overridevirtual

Return the probability density or mass function at vector x.

Parameters

x	The input vector x

Implements LikelihoodFunctionBase.

Reimplemented in ExtremeValue, and TruncatedGaussian.

Definition at line 77 of file Gaussian.C.

 {
   return function(_exp_values, x, _noise, _log_likelihood);
 }

◆ function() [2/2]

Real Gaussian::function	(	const std::vector< Real > &	exp,
		const std::vector< Real > &	model,
		const Real &	noise,
		const bool &	log_likelihood
	)

static

Return the probability density function.

Parameters

exp	The experimental measurement
model	The model prediction
noise	The standard deviation
log_likelihood	Bool to return the log likelihood value

Definition at line 58 of file Gaussian.C.

 {
   Real result = 0.0;
   Real val1;
   for (unsigned i = 0; i < exp.size(); ++i)
   {
     val1 = Normal::pdf(exp[i], model[i], noise);
     val1 = std::log(val1);
     result += val1;
   }
   if (!log_likelihood)
     result = std::exp(result);
   return result;
 }

◆ validParams()

InputParameters Gaussian::validParams ( )

static

Definition at line 17 of file Gaussian.C.

Referenced by ExtremeValue::validParams(), and TruncatedGaussian::validParams().

 {
   InputParameters params = LikelihoodFunctionBase::validParams();
   params.addClassDescription(
       "Gaussian likelihood function evaluating the model goodness against experiments.");
   params.addParam<bool>("log_likelihood", true, "Compute log-likelihood or likelihood.");
   params.addRequiredParam<ReporterName>(
       "noise", "Experimental noise plus model deviations against experiments.");
   params.addParam<FileName>("file_name", "Name of the CSV file with experimental values.");
   params.addParam<std::string>(
       "file_column_name", "Name of column in CSV file to use, by default first column is used.");
   params.addParam<std::vector<Real>>(
       "exp_values", "User-specified experimental values when CSV file is not provided.");
   return params;
 }

Member Data Documentation

◆ _exp_values

std::vector<Real> Gaussian::_exp_values

protected

Experimental data values.

Definition at line 47 of file Gaussian.h.

Referenced by ExtremeValue::function(), TruncatedGaussian::function(), function(), and Gaussian().

◆ _log_likelihood

const bool Gaussian::_log_likelihood

protected

return log-likelihood or likelihood

Definition at line 41 of file Gaussian.h.

Referenced by ExtremeValue::function(), TruncatedGaussian::function(), and function().

◆ _noise

const Real& Gaussian::_noise

protected

Noise value.

Definition at line 44 of file Gaussian.h.

Referenced by ExtremeValue::function(), TruncatedGaussian::function(), and function().

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

stochastic_tools/include/likelihoods/Gaussian.h
stochastic_tools/src/likelihoods/Gaussian.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Gaussian()

Member Function Documentation

◆ function() [1/2]

◆ function() [2/2]

◆ validParams()

Member Data Documentation

◆ _exp_values

◆ _log_likelihood

◆ _noise