A deprecated wrapper class used to generate a Weibull distribution. More...

#include <WeibullDistribution.h>

Inheritance diagram for WeibullDistribution:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	WeibullDistribution (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, const Real &shape)

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

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

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 &	_a
	The location parameter (a or low)

const Real &	_b
	The scale parameter (b or lambda)

const Real &	_c
	The shape parameter (c or k)

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 deprecated wrapper class used to generate a Weibull distribution.

Definition at line 17 of file WeibullDistribution.h.

Constructor & Destructor Documentation

◆ WeibullDistribution()

WeibullDistribution::WeibullDistribution ( const InputParameters & parameters )

Definition at line 20 of file WeibullDistribution.C.

                                                                           : Weibull(parameters)
{
}

Member Function Documentation

◆ cdf() [1/2]

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

overridevirtualinherited

Implements Distribution.

Definition at line 72 of file Weibull.C.

{
  return cdf(x, _a, _b, _c);
}

Referenced by Weibull::cdf().

◆ cdf() [2/2]

Real Weibull::cdf	(	const Real &	x,
		const Real &	location,
		const Real &	scale,
		const Real &	shape
	)

staticinherited

Definition at line 48 of file Weibull.C.

{
  if (x <= location)
    return 0.0;
  else
  {
    const Real y = (x - location) / scale;
    return 1.0 - std::exp(-std::pow(y, shape));
  }
}

◆ pdf() [1/2]

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

overridevirtualinherited

Implements Distribution.

Definition at line 66 of file Weibull.C.

{
  return pdf(x, _a, _b, _c);
}

Referenced by Weibull::pdf().

◆ pdf() [2/2]

Real Weibull::pdf	(	const Real &	x,
		const Real &	location,
		const Real &	scale,
		const Real &	shape
	)

staticinherited

Definition at line 36 of file Weibull.C.

{
  if (x <= location)
    return 0.0;
  else
  {
    const Real y = (x - location) / scale;
    return shape / scale * std::pow(y, shape - 1.0) * std::exp(-std::pow(y, shape));
  }
}

◆ quantile() [1/2]

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

overridevirtualinherited

Implements Distribution.

Definition at line 78 of file Weibull.C.

{
  return quantile(p, _a, _b, _c);
}

Referenced by Weibull::quantile().

◆ quantile() [2/2]

Real Weibull::quantile	(	const Real &	p,
		const Real &	location,
		const Real &	scale,
		const Real &	shape
	)

staticinherited

Definition at line 60 of file Weibull.C.

{
  return location + scale * std::pow(-std::log(1 - p), 1.0 / shape);
}

◆ validParams()

InputParameters WeibullDistribution::validParams ( )

static

Definition at line 15 of file WeibullDistribution.C.

{
  return Weibull::validParams();
}

Member Data Documentation

◆ _a

const Real& Weibull::_a

protectedinherited

The location parameter (a or low)

Definition at line 35 of file Weibull.h.

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

◆ _b

const Real& Weibull::_b

protectedinherited

The scale parameter (b or lambda)

Definition at line 38 of file Weibull.h.

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

◆ _c

const Real& Weibull::_c

protectedinherited

The shape parameter (c or k)

Definition at line 41 of file Weibull.h.

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

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

stochastic_tools/include/distributions/WeibullDistribution.h
stochastic_tools/src/distributions/WeibullDistribution.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

◆ WeibullDistribution()

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

◆ _a

◆ _b

◆ _c