A class used to generate a lognormal distribution. More...

#include <Lognormal.h>

Inheritance diagram for Lognormal:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	Lognormal (const InputParameters &parameters)

virtual Real	pdf (const Real &x) const override

virtual Real	cdf (const Real &x) const override

virtual Real	quantile (const Real &p) const override

virtual Real	median () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

bool	isKokkosObject () 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	mooseDeprecatedNoTrace (Args &&... args) const

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

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) 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

PerfGraph &	perfGraph ()

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	pdf (const Real &x, const Real &location, const Real &scale)

static Real	cdf (const Real &x, const Real &location, const Real &scale)

static Real	quantile (const Real &p, const Real &location, const Real &scale)

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

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

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

Protected Attributes
const Real &	_location
	The lognormal location parameter (m or mu)

const Real &	_scale
	The lognormal scale parameter (s or sigma)

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

Detailed Description

A class used to generate a lognormal distribution.

Definition at line 17 of file Lognormal.h.

Constructor & Destructor Documentation

◆ Lognormal()

Lognormal::Lognormal ( const InputParameters & parameters )

Definition at line 27 of file Lognormal.C.

  : Distribution(parameters), _location(getParam<Real>("location")), _scale(getParam<Real>("scale"))
{
}

Member Function Documentation

◆ cdf() [1/2]

Real Lognormal::cdf ( const Real & x ) const

overridevirtual

Implements Distribution.

Definition at line 58 of file Lognormal.C.

{
  return cdf(x, _location, _scale);
}

Referenced by cdf().

◆ cdf() [2/2]

Real Lognormal::cdf	(	const Real &	x,
		const Real &	location,
		const Real &	scale
	)

static

Definition at line 40 of file Lognormal.C.

{
  return 0.5 * (1.0 + std::erf((std::log(x) - location) / (scale * std::sqrt(2.0))));
}

◆ pdf() [1/2]

Real Lognormal::pdf ( const Real & x ) const

overridevirtual

Implements Distribution.

Definition at line 52 of file Lognormal.C.

{
  return pdf(x, _location, _scale);
}

Referenced by pdf().

◆ pdf() [2/2]

Real Lognormal::pdf	(	const Real &	x,
		const Real &	location,
		const Real &	scale
	)

static

Definition at line 33 of file Lognormal.C.

{
  return 1.0 / (x * scale * std::sqrt(2.0 * M_PI)) *
         std::exp(-0.5 * Utility::pow<2>((std::log(x) - location) / scale));
}

◆ quantile() [1/2]

Real Lognormal::quantile ( const Real & p ) const

overridevirtual

Implements Distribution.

Definition at line 64 of file Lognormal.C.

{
  return quantile(p, _location, _scale);
}

Referenced by quantile().

◆ quantile() [2/2]

Real Lognormal::quantile	(	const Real &	p,
		const Real &	location,
		const Real &	scale
	)

static

Definition at line 46 of file Lognormal.C.

{
  return std::exp(Normal::quantile(p, location, scale));
}

◆ validParams()

InputParameters Lognormal::validParams ( )

static

Definition at line 18 of file Lognormal.C.

{
  InputParameters params = Distribution::validParams();
  params.addClassDescription("Lognormal distribution");
  params.addRequiredParam<Real>("location", "The Lognormal location parameter (m or mu).");
  params.addRequiredParam<Real>("scale", "The Lognormal scale parameter (s or sigma).");
  return params;
}

Member Data Documentation

◆ _location

const Real& Lognormal::_location

protected

The lognormal location parameter (m or mu)

Definition at line 34 of file Lognormal.h.

Referenced by cdf(), pdf(), and quantile().

◆ _scale

const Real& Lognormal::_scale

protected

The lognormal scale parameter (s or sigma)

Definition at line 37 of file Lognormal.h.

Referenced by cdf(), pdf(), and quantile().

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

stochastic_tools/include/distributions/Lognormal.h
stochastic_tools/src/distributions/Lognormal.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Lognormal()

Member Function Documentation

◆ cdf() [1/2]

◆ cdf() [2/2]

◆ pdf() [1/2]

◆ pdf() [2/2]

◆ quantile() [1/2]

◆ quantile() [2/2]

◆ validParams()

Member Data Documentation

◆ _location

◆ _scale