Loading [MathJax]/extensions/tex2jax.js
https://mooseframework.inl.gov
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
JohnsonSBDistribution Class Reference

A deprecated wrapper class used to generate a Johnson SB distribution. More...

#include <JohnsonSBDistribution.h>

Inheritance diagram for JohnsonSBDistribution:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 JohnsonSBDistribution (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
 
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 & 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
 
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 &a, const Real &b, const Real &alpha_1, const Real &alpha_2)
 
static Real pdf (const Real &x, const Real &mean, const Real &std_dev)
 
static Real cdf (const Real &x, const Real &a, const Real &b, const Real &alpha_1, const Real &alpha_2)
 
static Real cdf (const Real &x, const Real &mean, const Real &std_dev)
 
static Real quantile (const Real &p, const Real &a, const Real &b, const Real &alpha_1, const Real &alpha_2)
 
static Real quantile (const Real &p, const Real &mean, const Real &std_dev)
 

Public Attributes

const ConsoleStream _console
 

Protected Member Functions

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 & _lower
 The lower location parameter, a. More...
 
const Real & _upper
 The upper location parameter, b. More...
 
const Real & _alpha_1
 The first shape parameter, alpha_1. More...
 
const Real & _alpha_2
 The second shape parameter, alpha_2. More...
 
const Real & _mean
 The mean (or expectation) of the distribution (mu) More...
 
const Real & _standard_deviation
 The standard deviation of the distribution (sigma) More...
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

Static Protected Attributes

static const std::array< Real, 6 > _a
 
static const std::array< Real, 6 > _b
 

Detailed Description

A deprecated wrapper class used to generate a Johnson SB distribution.

Definition at line 17 of file JohnsonSBDistribution.h.

Constructor & Destructor Documentation

◆ JohnsonSBDistribution()

JohnsonSBDistribution::JohnsonSBDistribution ( const InputParameters &  parameters)

Definition at line 23 of file JohnsonSBDistribution.C.

24  : JohnsonSB(parameters)
25 {
26 }
JohnsonSB::JohnsonSB
JohnsonSB(const InputParameters &parameters)
Definition: JohnsonSB.C:35
Distribution::parameters
const InputParameters & parameters() const

Member Function Documentation

◆ cdf() [1/3]

Real JohnsonSB::cdf ( const Real &  x) const
overridevirtualinherited

Reimplemented from Normal.

Definition at line 88 of file JohnsonSB.C.

89 {
90  return cdf(x, _lower, _upper, _alpha_1, _alpha_2);
91 }
x
const std::vector< double > x
Definition: EquilibriumConstantFitTest.C:17
JohnsonSB::_alpha_2
const Real & _alpha_2
The second shape parameter, alpha_2.
Definition: JohnsonSB.h:46
JohnsonSB::_alpha_1
const Real & _alpha_1
The first shape parameter, alpha_1.
Definition: JohnsonSB.h:43
JohnsonSB::_lower
const Real & _lower
The lower location parameter, a.
Definition: JohnsonSB.h:37
JohnsonSB::cdf
virtual Real cdf(const Real &x) const override
Definition: JohnsonSB.C:88
JohnsonSB::_upper
const Real & _upper
The upper location parameter, b.
Definition: JohnsonSB.h:40

◆ cdf() [2/3]

Real Normal::cdf ( const Real &  x,
const Real &  mean,
const Real &  std_dev 
)
staticinherited

Definition at line 48 of file Normal.C.

49 {
50  return 0.5 * (1.0 + std::erf((x - mean) / (std_dev * std::sqrt(2.0))));
51 }
x
const std::vector< double > x
Definition: EquilibriumConstantFitTest.C:17

◆ cdf() [3/3]

Real JohnsonSB::cdf ( const Real &  x,
const Real &  a,
const Real &  b,
const Real &  alpha_1,
const Real &  alpha_2 
)
staticinherited

Definition at line 60 of file JohnsonSB.C.

62 {
63  if (x <= a)
64  return 0.0;
65  else if (x < b)
66  {
67  return Normal::cdf(alpha_1 + alpha_2 * std::log((x - a) / (b - x)), 0.0, 1.0);
68  }
69  else
70  return 0.0;
71 }
Normal::cdf
virtual Real cdf(const Real &x) const override
Definition: Normal.C:74
x
const std::vector< double > x
Definition: EquilibriumConstantFitTest.C:17

◆ pdf() [1/3]

Real JohnsonSB::pdf ( const Real &  x) const
overridevirtualinherited

Reimplemented from Normal.

Definition at line 82 of file JohnsonSB.C.

83 {
84  return pdf(x, _lower, _upper, _alpha_1, _alpha_2);
85 }
x
const std::vector< double > x
Definition: EquilibriumConstantFitTest.C:17
JohnsonSB::_alpha_2
const Real & _alpha_2
The second shape parameter, alpha_2.
Definition: JohnsonSB.h:46
JohnsonSB::pdf
virtual Real pdf(const Real &x) const override
Definition: JohnsonSB.C:82
JohnsonSB::_alpha_1
const Real & _alpha_1
The first shape parameter, alpha_1.
Definition: JohnsonSB.h:43
JohnsonSB::_lower
const Real & _lower
The lower location parameter, a.
Definition: JohnsonSB.h:37
JohnsonSB::_upper
const Real & _upper
The upper location parameter, b.
Definition: JohnsonSB.h:40

◆ pdf() [2/3]

Real Normal::pdf ( const Real &  x,
const Real &  mean,
const Real &  std_dev 
)
staticinherited

Definition at line 41 of file Normal.C.

42 {
43  return 1.0 / (std_dev * std::sqrt(2.0 * M_PI)) *
44  std::exp(-0.5 * Utility::pow<2>((x - mean) / std_dev));
45 }
x
const std::vector< double > x
Definition: EquilibriumConstantFitTest.C:17

◆ pdf() [3/3]

Real JohnsonSB::pdf ( const Real &  x,
const Real &  a,
const Real &  b,
const Real &  alpha_1,
const Real &  alpha_2 
)
staticinherited

Definition at line 45 of file JohnsonSB.C.

47 {
48  if (x <= a)
49  return 0.0;
50  else if (x < b)
51  {
52  return (alpha_2 * (b - a)) / ((x - a) * (b - x) * std::sqrt(2.0 * M_PI)) *
53  std::exp(-0.5 * Utility::pow<2>(alpha_1 + alpha_2 * std::log((x - a) / (b - x))));
54  }
55  else
56  return 0.0;
57 }
x
const std::vector< double > x
Definition: EquilibriumConstantFitTest.C:17

◆ quantile() [1/3]

Real JohnsonSB::quantile ( const Real &  p) const
overridevirtualinherited

Reimplemented from Normal.

Definition at line 94 of file JohnsonSB.C.

95 {
96  return quantile(p, _lower, _upper, _alpha_1, _alpha_2);
97 }
JohnsonSB::_alpha_2
const Real & _alpha_2
The second shape parameter, alpha_2.
Definition: JohnsonSB.h:46
JohnsonSB::_alpha_1
const Real & _alpha_1
The first shape parameter, alpha_1.
Definition: JohnsonSB.h:43
JohnsonSB::_lower
const Real & _lower
The lower location parameter, a.
Definition: JohnsonSB.h:37
JohnsonSB::quantile
virtual Real quantile(const Real &p) const override
Definition: JohnsonSB.C:94
JohnsonSB::_upper
const Real & _upper
The upper location parameter, b.
Definition: JohnsonSB.h:40

◆ quantile() [2/3]

Real Normal::quantile ( const Real &  p,
const Real &  mean,
const Real &  std_dev 
)
staticinherited

Definition at line 54 of file Normal.C.

55 {
56  const Real x = (p < 0.5 ? p : 1.0 - p);
57  const Real y = std::sqrt(-2.0 * std::log(x));
58  const Real y2 = y * y;
59  const Real y3 = y2 * y;
60  const Real y4 = y3 * y;
61  const Real sgn = (p - 0.5 < 0.0 ? -1.0 : 1.0);
62  const Real Zp = sgn * (y + (_a[0] + _a[1] * y + _a[2] * y2 + _a[3] * y3 + _a[4] * y4) /
63  (_b[0] + _b[1] * y + _b[2] * y2 + _b[3] * y3 + _b[4] * y4));
64  return Zp * std_dev + mean;
65 }
THM::sgn
int sgn(T val)
The sign function.
Definition: Numerics.h:40
y
const std::vector< double > y
Definition: EquilibriumConstantFitTest.C:18
x
const std::vector< double > x
Definition: EquilibriumConstantFitTest.C:17
Normal::_a
static const std::array< Real, 6 > _a
Definition: Normal.h:35
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
Normal::_b
static const std::array< Real, 6 > _b
Definition: Normal.h:36

◆ quantile() [3/3]

Real JohnsonSB::quantile ( const Real &  p,
const Real &  a,
const Real &  b,
const Real &  alpha_1,
const Real &  alpha_2 
)
staticinherited

Definition at line 74 of file JohnsonSB.C.

76 {
77  const Real Z = Normal::quantile(p, 0.0, 1.0);
78  return (a + b * std::exp((Z - alpha_1) / alpha_2)) / (1.0 + std::exp((Z - alpha_1) / alpha_2));
79 }
NS::Z
static const std::string Z
Definition: NS.h:169
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
Normal::quantile
virtual Real quantile(const Real &p) const override
Definition: Normal.C:80

◆ validParams()

InputParameters JohnsonSBDistribution::validParams ( )
static

Definition at line 18 of file JohnsonSBDistribution.C.

19 {
20  return JohnsonSB::validParams();
21 }
JohnsonSB::validParams
static InputParameters validParams()
Definition: JohnsonSB.C:17

Member Data Documentation

◆ _a

const std::array< Real, 6 > Normal::_a
staticprotectedinherited
Initial value:
= {
{-0.322232431088, -1.0, -0.342242088547, -0.0204231210245, -0.0000453642210148}}

Coefficients for the rational function used to approximate the quantile

Definition at line 35 of file Normal.h.

Referenced by Normal::quantile().

◆ _alpha_1

const Real& JohnsonSB::_alpha_1
protectedinherited

The first shape parameter, alpha_1.

Definition at line 43 of file JohnsonSB.h.

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

◆ _alpha_2

const Real& JohnsonSB::_alpha_2
protectedinherited

The second shape parameter, alpha_2.

Definition at line 46 of file JohnsonSB.h.

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

◆ _b

const std::array< Real, 6 > Normal::_b
staticprotectedinherited
Initial value:
= {
{0.099348462606, 0.588581570495, 0.531103462366, 0.10353775285, 0.0038560700634}}

Definition at line 36 of file Normal.h.

Referenced by Normal::quantile().

◆ _lower

const Real& JohnsonSB::_lower
protectedinherited

The lower location parameter, a.

Definition at line 37 of file JohnsonSB.h.

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

◆ _mean

const Real& Normal::_mean
protectedinherited

The mean (or expectation) of the distribution (mu)

Definition at line 40 of file Normal.h.

Referenced by Normal::cdf(), TruncatedNormal::cdf(), TruncatedNormal::pdf(), Normal::pdf(), TruncatedNormal::quantile(), and Normal::quantile().

◆ _standard_deviation

const Real& Normal::_standard_deviation
protectedinherited

The standard deviation of the distribution (sigma)

Definition at line 43 of file Normal.h.

Referenced by Normal::cdf(), TruncatedNormal::cdf(), TruncatedNormal::pdf(), Normal::pdf(), TruncatedNormal::quantile(), and Normal::quantile().

◆ _upper

const Real& JohnsonSB::_upper
protectedinherited

The upper location parameter, b.

Definition at line 40 of file JohnsonSB.h.

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

The documentation for this class was generated from the following files:
Generated on Tue Apr 15 2025 16:26:17 for https://mooseframework.inl.gov by   doxygen 1.8.14