Standard normal distribution. Not selectable. More...


Public Member Functions | |
| TypeName ("standardNormal") | |
| Runtime type information. More... | |
| standardNormal (randomGenerator &&rndGen) | |
| Construct from a random generator. More... | |
| standardNormal (const randomGenerator::seed &s, const bool global=false) | |
| Construct from a seed. More... | |
| standardNormal (const standardNormal &d) | |
| Construct copy. More... | |
| virtual autoPtr< distribution > | clone (const label sampleQ) const |
| Construct and return a clone. More... | |
| virtual | ~standardNormal () |
| 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 tmp< scalarField > | integralPDFxPow (const scalarField &x, const label e, const bool consistent=false) const |
| Return the integral of the PDF multiplied by an integer power of x. More... | |
| virtual tmp< scalarField > | plotX (const label n) const |
| Return coordinates to plot across the range of the distribution. More... | |
| virtual tmp< scalarField > | plotPDF (const scalarField &x) const |
| Return values to plot the probability density function. More... | |
Public Member Functions inherited from FieldDistribution< distribution, standardNormal > | |
| 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... | |
Public Member Functions inherited from distribution | |
| 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... | |
| label | sampleQ () const |
| Access the sample size exponent. More... | |
| void | start (const bool repeat) const |
| Start a sequence of samples. Either a new sequence, or a. More... | |
| template<class Type > | |
| Type | sample () const |
| Sample the distribution into components of a primitive type. More... | |
| virtual tmp< scalarField > | CDF (const scalarField &x) const |
| Return the cumulative density function at the given coordinates. More... | |
| virtual void | write (Ostream &os, const unitConversion &units) const |
| Write to a stream. More... | |
| virtual void | writeState (Ostream &os) const |
| Write the state to a stream. More... | |
Static Public Member Functions | |
| static tmp< scalarField > | approxErf (const scalarField &x) |
| Approximate error function. More... | |
| static scalar | approxErfInv (const scalar y) |
| Approximate error function inverse. More... | |
Static Public Member Functions inherited from distribution | |
| 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... | |
Friends | |
| class | multiNormal |
| Permit the multiNormal distribution to use private parts of this class. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from FieldDistribution< distribution, standardNormal > | |
| FOR_ALL_FIELD_TYPES (VIRTUAL_SAMPLE_TYPE) | |
Protected Member Functions inherited from distribution | |
| 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) | |
Protected Attributes inherited from distribution | |
| const label | Q_ |
| Distribution size exponent. More... | |
| const label | sampleQ_ |
| Sample size exponent. More... | |
| restartableRandomGenerator | rndGen_ |
| Random number generator. More... | |
Standard normal distribution. Not selectable.
Definition at line 57 of file standardNormal.H.
| standardNormal | ( | randomGenerator && | rndGen | ) |
Construct from a random generator.
Definition at line 67 of file standardNormal.C.
Referenced by standardNormal::clone().

| standardNormal | ( | const randomGenerator::seed & | s, |
| const bool | global = false |
||
| ) |
Construct from a seed.
Definition at line 73 of file standardNormal.C.
| standardNormal | ( | const standardNormal & | d | ) |
Construct copy.
Definition at line 83 of file standardNormal.C.
|
virtual |
Destructor.
Definition at line 91 of file standardNormal.C.
| TypeName | ( | "standardNormal" | ) |
Runtime type information.
|
static |
Approximate error function.
Definition at line 49 of file standardNormal.C.
References Foam::exp(), Foam::constant::mathematical::pi(), Foam::sign(), Foam::sqr(), Foam::sqrt(), and x.

|
static |
Approximate error function inverse.
Definition at line 58 of file standardNormal.C.
References b, Foam::log(), Foam::max(), Foam::constant::mathematical::pi(), Foam::sign(), Foam::sqrt(), and y.
Referenced by normal::sampleForZeroQ().


|
inlinevirtual |
Construct and return a clone.
Implements distribution.
Definition at line 102 of file standardNormal.H.
References standardNormal::standardNormal().

|
virtual |
Sample the distribution.
Implements distribution.
Definition at line 97 of file standardNormal.C.
References s(), and Foam::sqrt().
Referenced by BrownianMotionForce< CloudType >::calcCoupled(), turbulentDispersion::calculate(), MaxwellianThermal< CloudType >::correct(), MixedDiffuseSpecular< CloudType >::correct(), FreeStream< CloudType >::inflow(), GradientDispersionRAS< CloudType >::update(), and StochasticDispersionRAS< CloudType >::update().


|
virtual |
|
virtual |
|
virtual |
|
virtual |
Return the integral of the PDF multiplied by an integer power of x.
Implements distribution.
Definition at line 124 of file standardNormal.C.
References Foam::e, NotImplemented, Foam::sqrt(), and x.

|
virtual |
Return coordinates to plot across the range of the distribution.
Reimplemented from distribution.
Definition at line 139 of file standardNormal.C.
References f(), forAll, n, and tmp< T >::ref().

|
virtual |
Return values to plot the probability density function.
Implements distribution.
Definition at line 157 of file standardNormal.C.
References Foam::exp(), Foam::constant::mathematical::pi(), Foam::sqr(), Foam::sqrt(), and x.

|
friend |
Permit the multiNormal distribution to use private parts of this class.
Definition at line 74 of file standardNormal.H.