Public Member Functions | |
unintegrable (const word &name, const unitConversion &units, const dictionary &dict, const label sampleQ, randomGenerator &&rndGen) | |
Inherit constructors. More... | |
unintegrable (const label Q, const label sampleQ, randomGenerator &&rndGen, const label n) | |
Inherit constructors. More... | |
unintegrable (const unintegrable &d, const label sampleQ) | |
Inherit constructors. More... | |
![]() | |
unintegrable (const word &name, const unitConversion &units, const dictionary &dict, const label sampleQ, randomGenerator &&rndGen) | |
Construct from a dictionary. More... | |
unintegrable (const label Q, const label sampleQ, randomGenerator &&rndGen, const label n) | |
Construct from components. More... | |
unintegrable (const unintegrable &d, const label sampleQ) | |
Construct copy. More... | |
virtual | ~unintegrable () |
Destructor. More... | |
scalar | sample () const |
Sample the distribution. 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... | |
virtual scalar | sample () const=0 |
Sample the distribution. More... | |
template<class Type > | |
Type | sample () const |
Sample the distribution. More... | |
virtual tmp< scalarField > | sample (const label n) const=0 |
Sample the distribution. More... | |
virtual tmp< scalarField > | x (const label n) const |
Return coordinates to plot across the range of the distribution. 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... | |
virtual autoPtr< distribution > | clone (const label sampleQ) const =0 |
Construct and return a clone. 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 tmp< scalarField > | sample (const label n) const =0 |
Sample the distribution into a field. More... | |
virtual scalar | min () const =0 |
Return the minimum value. More... | |
virtual scalar | max () const =0 |
Return the maximum value. 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... | |
Protected Member Functions | |
virtual Pair< scalar > | Phi01 (const label q) const |
Return values of the un-normalised CDF at the minimum and maximum. More... | |
virtual Pair< scalar > | Phi01 (const label q) const |
Access cached values of the un-normalised CDF at the minimum and. More... | |
const Pair< scalar > & | Phi01 () const |
Access cached values of the un-normalised CDF at the minimum and. More... | |
![]() | |
virtual tmp< scalarField > | phi (const label q, const scalarField &x) const =0 |
Return values of the un-normalised PDF for the given size exponent. More... | |
virtual tmp< scalarField > | Phi (const label q, const scalarField &x) const |
Return values of the un-normalised CDF for the given size exponent. More... | |
const Pair< scalar > & | Phi01 () const |
Access cached values of the un-normalised CDF at the minimum and. More... | |
![]() | |
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) | |
Additional Inherited Members | |
![]() | |
static tmp< scalarField > | integrate (const scalarField &x, const scalarField &y) |
Integrate the values y with respect to the coordinates x. More... | |
static tmp< scalarField > | integrateX (const scalarField &x, const scalarField &y) |
Integrate the values x*y with respect to the coordinates x. More... | |
static scalar | sampleInterval (const Pair< scalar > &x, const Pair< scalar > &Phi, const scalar s) |
Sample an interval, given the interval's bounding x-coordinates,. More... | |
static scalar | sampleInterval (const Pair< scalar > &x, const Pair< scalar > &phi, const Pair< scalar > &Phi, const scalar s) |
Sample an interval, given the interval's bounding x-coordinates,. More... | |
static scalar | sample (const scalarField &x, const scalarField &Phi, const scalar s) |
Sample a discretised distribution, given the x-coordinates,. More... | |
static scalar | sample (const scalarField &x, const scalarField &phi, const scalarField &Phi, const scalar s) |
Sample a discretised distribution, given the x-coordinates, values. More... | |
![]() | |
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... | |
![]() | |
const label | Q_ |
Distribution size exponent. More... | |
const label | sampleQ_ |
Sample size exponent. More... | |
randomGenerator | rndGen_ |
Random number generator. More... | |
Definition at line 238 of file unintegrable.H.
|
protectedvirtual |
Return values of the un-normalised CDF at the minimum and maximum.
x-coordinates for the given size exponent.
Reimplemented from unintegrable.
Definition at line 274 of file unintegrable.C.
References UList< T >::first(), UList< T >::last(), Foam::max(), Foam::min(), unintegrable::Phi01(), and x.
|
protected |
Access cached values of the un-normalised CDF at the minimum and.
maximum x-coordinates.
Definition at line 115 of file unintegrable.C.
References f().
|
protected |
Access cached values of the un-normalised CDF at the minimum and.
maximum x-coordinates.
Definition at line 119 of file unintegrable.C.
Inherit constructors.
Definition at line 186 of file unintegrable.C.
Inherit constructors.
Definition at line 196 of file unintegrable.C.
References Foam::max().
Inherit constructors.
Definition at line 205 of file unintegrable.C.