All Likelihoods should inherit from this class. More...

#include <LikelihoodFunctionBase.h>

Inheritance diagram for LikelihoodFunctionBase:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	LikelihoodFunctionBase (const InputParameters &parameters)

virtual Real	function (const std::vector< Real > &x) const =0
	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

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

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

void	callMooseError (std::string msg, const bool with_prefix) const

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

const InputParameters &	parameters () const

MooseObjectName	uniqueName () 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 &nm) const

void	paramError (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

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

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

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

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

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

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

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

void	mooseInfo (Args &&... args) 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 ()

Public Attributes
const ConsoleStream	_console

Protected Attributes
const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

const Parallel::Communicator &	_communicator

Detailed Description

All Likelihoods should inherit from this class.

Definition at line 18 of file LikelihoodFunctionBase.h.

Constructor & Destructor Documentation

◆ LikelihoodFunctionBase()

LikelihoodFunctionBase::LikelihoodFunctionBase ( const InputParameters & parameters )

Definition at line 22 of file LikelihoodFunctionBase.C.

   : MooseObject(parameters)
 {
 }

Member Function Documentation

◆ function()

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

pure virtual

Return the probability density or mass function at vector x.

Parameters

x	The input vector x

Implemented in Gaussian, ExtremeValue, and TruncatedGaussian.

◆ validParams()

InputParameters LikelihoodFunctionBase::validParams ( )

static

Definition at line 13 of file LikelihoodFunctionBase.C.

Referenced by Gaussian::validParams().

 {
   InputParameters params = MooseObject::validParams();
   params.addClassDescription("Base class for likelihood functions");
   params.registerBase("LikelihoodFunctionBase");
   params.registerSystemAttributeName("LikelihoodFunctionBase");
   return params;
 }

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

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

Public Types

Public Member Functions

Static Public Member Functions