www.mooseframework.org
Distribution.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef DISTRIBUTION_H
16 #define DISTRIBUTION_H
17 
18 #include "MooseObject.h"
19 
20 class Distribution;
21 
22 template <>
24 
28 class Distribution : public MooseObject
29 {
30 public:
35  virtual Real pdf(const Real & x) = 0;
36 
40  virtual Real cdf(const Real & x) = 0;
41 
45  virtual Real quantile(const Real & y) = 0;
46 };
47 
48 #endif /* DISTRIBUTION_H */
virtual Real cdf(const Real &x)=0
Compute the cumulative probability with given cumulative probability distribution (CDF) at x...
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
All Distributions should inherit from this class.
Definition: Distribution.h:28
static PetscErrorCode Vec x
Distribution(const InputParameters &parameters)
Definition: Distribution.C:27
virtual Real quantile(const Real &y)=0
Compute the inverse CDF (quantile function) value for given variable value y.
Every object that can be built by the factory should be derived from this class.
Definition: MooseObject.h:36
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
InputParameters validParams< Distribution >()
Definition: Distribution.C:20
virtual Real pdf(const Real &x)=0
Compute the probability with given probability distribution function (PDF) at x.