A general distribution model where the distribution is specified as (point, value) pairs. By default the values are assumed to represent a probability density function, but the model also supports specifying a cumulative distribution function. In both cases it is assumed that the function is linear between the specified points. More...
Public Member Functions | |
| TypeName ("general") | |
| Runtime type information. More... | |
| general (const dictionary &dict, Random &rndGen) | |
| Construct from components. More... | |
| general (const general &p) | |
| Construct copy. More... | |
| virtual autoPtr< distributionModel > | clone () const |
| Construct and return a clone. More... | |
| virtual | ~general () |
| Destructor. More... | |
| virtual scalar | sample () const |
| Sample the distributionModel. More... | |
| virtual scalar | minValue () const |
| Return the minimum value. More... | |
| virtual scalar | maxValue () const |
| Return the maximum value. More... | |
| virtual scalar | meanValue () const |
| Return the mean value. More... | |
 Public Member Functions inherited from distributionModel | |
| TypeName ("distributionModel") | |
| Runtime type information. More... | |
| declareRunTimeSelectionTable (autoPtr, distributionModel, dictionary,(const dictionary &dict, Random &rndGen),(dict, rndGen)) | |
| Declare runtime constructor selection table. More... | |
| distributionModel (const word &name, const dictionary &dict, Random &rndGen) | |
| Construct from dictionary. More... | |
| distributionModel (const distributionModel &p) | |
| Construct copy. More... | |
| virtual | ~distributionModel () |
| Destructor. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from distributionModel | |
| static autoPtr< distributionModel > | New (const dictionary &dict, Random &rndGen) |
| Selector. More... | |
| Protected Member Functions inherited from distributionModel | |
| virtual void | check () const |
| Check that the distribution model is valid. More... | |
| void | info () const |
| Print information about the distribution. More... | |
| Protected Attributes inherited from distributionModel | |
| const dictionary | distributionModelDict_ |
| Coefficients dictionary. More... | |
| Random & | rndGen_ |
| Reference to the random number generator. More... | |
A general distribution model where the distribution is specified as (point, value) pairs. By default the values are assumed to represent a probability density function, but the model also supports specifying a cumulative distribution function. In both cases it is assumed that the function is linear between the specified points.
In both modes of operation the values are automatically normalised.
| general | ( | const dictionary & | dict, |
| Random & | rndGen | ||
| ) |
Construct from components.
Definition at line 43 of file general.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, k, Foam::sqr(), Foam::type(), Foam::y0(), and Foam::y1().
Referenced by general::clone().
|
virtual |
Destructor.
Definition at line 155 of file general.C.
Referenced by general::clone().
| TypeName | ( | "general" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone.
Implements distributionModel.
Definition at line 103 of file general.H.
References general::general(), general::maxValue(), general::meanValue(), general::minValue(), general::sample(), and general::~general().
|
virtual |
Sample the distributionModel.
Implements distributionModel.
Definition at line 161 of file general.C.
References alpha(), k, Foam::mag(), n, p, distributionModel::rndGen_, Random::sample01(), Foam::sqrt(), x, and y.
Referenced by general::clone().
|
virtual |
Return the minimum value.
Implements distributionModel.
Definition at line 210 of file general.C.
Referenced by general::clone().
|
virtual |
Return the maximum value.
Implements distributionModel.
Definition at line 216 of file general.C.
Referenced by general::clone().
|
virtual |
Return the mean value.
Implements distributionModel.
Definition at line 222 of file general.C.
Referenced by general::clone().
1.8.13 
