Distribution in which all values between a specified minimum and maximum have the same probability. More...
Public Member Functions | |
TypeName ("uniform") | |
Runtime type information. More... | |
uniform (const unitConversion &units, const dictionary &dict, const label sampleQ, randomGenerator &&rndGen) | |
Construct from a dictionary. More... | |
uniform (const uniform &d, const label sampleQ) | |
Construct copy. More... | |
virtual autoPtr< distribution > | clone (const label sampleQ) const |
Construct and return a clone. More... | |
virtual | ~uniform () |
Destructor. More... | |
virtual scalar | sample () const |
Sample the distribution. More... | |
virtual scalar | min () const |
Return the minimum value. More... | |
virtual scalar | max () const |
Return the maximum value. More... | |
virtual scalar | mean () const |
Return the mean value. More... | |
virtual void | write (Ostream &os, const unitConversion &units) const |
Write to a stream. More... | |
virtual tmp< scalarField > | PDF (const scalarField &x) const |
Return the distribution probability density function. More... | |
![]() | |
Type | sample () const |
Sample the distribution into components of a primitive type. More... | |
virtual tmp< scalarField > | sample (const label n) const |
Sample the distribution into a field. More... | |
![]() | |
TypeName ("distribution") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, distribution, dictionary,(const unitConversion &units, const dictionary &dict, const label sampleQ, randomGenerator &&rndGen),(units, dict, sampleQ, std::move(rndGen))) | |
Declare runtime constructor selection table. More... | |
distribution (const word &name, const unitConversion &units, const dictionary &dict, const label sampleQ, randomGenerator &&rndGen) | |
Construct from dictionary. More... | |
distribution (const label Q, const label sampleQ, randomGenerator &&rndGen) | |
Construct from components. More... | |
distribution (const distribution &d, const label sampleQ) | |
Construct copy. More... | |
autoPtr< distribution > | clone () const |
Construct and return a clone. More... | |
virtual | ~distribution () |
Destructor. More... | |
template<class Type > | |
Type | sample () const |
Sample the distribution into components of a primitive type. More... | |
virtual void | writeState (Ostream &os) const |
Write the state to a stream. More... | |
virtual tmp< scalarField > | x (const label n) const |
Return coordinates to plot across the range of the distribution. More... | |
Additional Inherited Members | |
![]() | |
static autoPtr< distribution > | New (const unitConversion &units, const dictionary &dict, const label sampleQ, randomGenerator &&rndGen, const bool report=true) |
Select from dictionary and a random generator. More... | |
static autoPtr< distribution > | New (const unitConversion &units, const dictionary &dict, const label sampleQ, const randomGenerator::seed &s, const bool global=false, const bool report=true) |
Select from a dictionary and a random generator seed and global flag. More... | |
static autoPtr< distribution > | New (autoPtr< distribution > &dPtr, const label sampleQ) |
Re-select with a different sample size exponent. More... | |
![]() | |
FOR_ALL_FIELD_TYPES (VIRTUAL_SAMPLE_TYPE) | |
![]() | |
virtual void | validateBounds (const dictionary &dict) const |
Validate that the bounds are monotonic. More... | |
virtual void | validatePositive (const dictionary &dict) const |
Validate that the lower bound is positive. More... | |
tmp< scalarField > | clipPDF (const scalarField &x, const tmp< scalarField > &pdf) const |
Clip the PDF values to zero outside the bounds. More... | |
label | q () const |
Return the effective distribution size exponent. More... | |
FOR_ALL_FIELD_TYPES (VIRTUAL_SAMPLE_TYPE) | |
![]() | |
const label | Q_ |
Distribution size exponent. More... | |
const label | sampleQ_ |
Sample size exponent. More... | |
randomGenerator | rndGen_ |
Random number generator. More... | |
Distribution in which all values between a specified minimum and maximum have the same probability.
{ type uniform; Q 0; min 0.5; max 1; }
uniform | ( | const unitConversion & | units, |
const dictionary & | dict, | ||
const label | sampleQ, | ||
randomGenerator && | rndGen | ||
) |
Construct from a dictionary.
Definition at line 58 of file uniform.C.
Referenced by uniform::clone().
TypeName | ( | "uniform" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone.
Implements distribution.
Definition at line 111 of file uniform.H.
References uniform::uniform().
|
virtual |
Sample the distribution.
Implements distribution.
Definition at line 102 of file uniform.C.
References Foam::integerRoot(), Foam::pow(), and s().
|
virtual |
|
virtual |
|
virtual |
Return the mean value.
Implements distribution.
Definition at line 131 of file uniform.C.
References Foam::integerPow(), and Foam::log().
|
virtual |
Write to a stream.
Reimplemented from distribution.
Definition at line 147 of file uniform.C.
References Foam::units(), distribution::write(), and Foam::writeEntry().
|
virtual |
Return the distribution probability density function.
Implements distribution.
Definition at line 161 of file uniform.C.
References Foam::integerPow(), Foam::log(), and x.