https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
UniformDistribution Class Reference

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

#include <UniformDistribution.h>

Inheritance diagram for UniformDistribution:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 UniformDistribution (const InputParameters &parameters)
 
virtual Real pdf (const Real &x) const override
 
virtual Real cdf (const Real &x) const override
 
virtual Real quantile (const Real &y) const override
 
virtual Real median () const
 
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
 
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 &lower_bound, const Real &upper_bound)
 
static Real cdf (const Real &x, const Real &lower_bound, const Real &upper_bound)
 
static Real quantile (const Real &y, const Real &lower_bound, const Real &upper_bound)
 
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
 
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_bound
 The lower bound for the uniform distribution. More...
 
const Real & _upper_bound
 The upper bound for the uniform distribution. More...
 
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
 

Detailed Description

A deprecated wrapper class used to generate a uniform distribution.

Definition at line 17 of file UniformDistribution.h.

Constructor & Destructor Documentation

◆ UniformDistribution()

UniformDistribution::UniformDistribution ( const InputParameters &  parameters)

Definition at line 20 of file UniformDistribution.C.

20  : Uniform(parameters)
21 {
22 }
Distribution::parameters
const InputParameters & parameters() const
Uniform::Uniform
Uniform(const InputParameters &parameters)
Definition: Uniform.C:24

Member Function Documentation

◆ cdf() [1/2]

Real Uniform::cdf ( const Real &  x,
const Real &  lower_bound,
const Real &  upper_bound 
)
staticinherited

Definition at line 43 of file Uniform.C.

Referenced by Uniform::cdf(), and KernelDensity1D::cdf().

44 {
45  if (x < lower_bound)
46  return 0.0;
47  else if (x > upper_bound)
48  return 1.0;
49  else
50  return (x - lower_bound) / (upper_bound - lower_bound);
51 }
x
const std::vector< double > x
Definition: EquilibriumConstantFitTest.C:17

◆ cdf() [2/2]

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

Implements Distribution.

Definition at line 69 of file Uniform.C.

70 {
71  return cdf(x, _lower_bound, _upper_bound);
72 }
x
const std::vector< double > x
Definition: EquilibriumConstantFitTest.C:17
Uniform::cdf
static Real cdf(const Real &x, const Real &lower_bound, const Real &upper_bound)
Definition: Uniform.C:43
Uniform::_lower_bound
const Real & _lower_bound
The lower bound for the uniform distribution.
Definition: Uniform.h:34
Uniform::_upper_bound
const Real & _upper_bound
The upper bound for the uniform distribution.
Definition: Uniform.h:37

◆ pdf() [1/2]

Real Uniform::pdf ( const Real &  x,
const Real &  lower_bound,
const Real &  upper_bound 
)
staticinherited

Definition at line 34 of file Uniform.C.

Referenced by KernelDensity1D::pdf(), and Uniform::pdf().

35 {
36  if (x < lower_bound || x > upper_bound)
37  return 0.0;
38  else
39  return 1.0 / (upper_bound - lower_bound);
40 }

◆ pdf() [2/2]

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

Implements Distribution.

Definition at line 63 of file Uniform.C.

64 {
65  return pdf(x, _lower_bound, _upper_bound);
66 }
Uniform::pdf
static Real pdf(const Real &x, const Real &lower_bound, const Real &upper_bound)
Definition: Uniform.C:34
x
const std::vector< double > x
Definition: EquilibriumConstantFitTest.C:17
Uniform::_lower_bound
const Real & _lower_bound
The lower bound for the uniform distribution.
Definition: Uniform.h:34
Uniform::_upper_bound
const Real & _upper_bound
The upper bound for the uniform distribution.
Definition: Uniform.h:37

◆ quantile() [1/2]

Real Uniform::quantile ( const Real &  y,
const Real &  lower_bound,
const Real &  upper_bound 
)
staticinherited

Definition at line 54 of file Uniform.C.

Referenced by Uniform::quantile(), and KernelDensity1D::quantile().

55 {
56  if (y < 0 || y > 1)
57  ::mooseError("The cdf_value provided is out of range 0 to 1.");
58  else
59  return y * (upper_bound - lower_bound) + lower_bound;
60 }
y
const std::vector< double > y
Definition: EquilibriumConstantFitTest.C:18
Distribution::mooseError
void mooseError(Args &&... args) const

◆ quantile() [2/2]

Real Uniform::quantile ( const Real &  y) const
overridevirtualinherited

Implements Distribution.

Definition at line 75 of file Uniform.C.

76 {
77  return quantile(y, _lower_bound, _upper_bound);
78 }
y
const std::vector< double > y
Definition: EquilibriumConstantFitTest.C:18
Uniform::quantile
static Real quantile(const Real &y, const Real &lower_bound, const Real &upper_bound)
Definition: Uniform.C:54
Uniform::_lower_bound
const Real & _lower_bound
The lower bound for the uniform distribution.
Definition: Uniform.h:34
Uniform::_upper_bound
const Real & _upper_bound
The upper bound for the uniform distribution.
Definition: Uniform.h:37

◆ validParams()

InputParameters UniformDistribution::validParams ( )
static

Definition at line 15 of file UniformDistribution.C.

16 {
17  return Uniform::validParams();
18 }
Uniform::validParams
static InputParameters validParams()
Definition: Uniform.C:15

Member Data Documentation

◆ _lower_bound

const Real& Uniform::_lower_bound
protectedinherited

The lower bound for the uniform distribution.

Definition at line 34 of file Uniform.h.

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

◆ _upper_bound

const Real& Uniform::_upper_bound
protectedinherited

The upper bound for the uniform distribution.

Definition at line 37 of file Uniform.h.

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

The documentation for this class was generated from the following files:
Generated on Wed Nov 5 2025 20:32:27 for https://mooseframework.inl.gov by   doxygen 1.8.14