Loading...
Searching...
No Matches
distributionModel Class Referenceabstract

A library of runtime-selectable doubly-truncated probability distribution models. Returns random samples based on given distribution parameters. More...

#include <distributionModel.H>

Inheritance diagram for distributionModel:
Inheritance graph
[legend]
Collaboration diagram for distributionModel:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("distributionModel")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, distributionModel, dictionary,(const dictionary &dict, Random &rndGen),(dict, rndGen))
 Declare runtime constructor selection table.
 distributionModel (const word &name, const dictionary &dict, Random &rndGen)
 Construct from dictionary.
 distributionModel (const distributionModel &p)
 Copy construct.
virtual autoPtr< distributionModel > clone () const =0
 Construct and return a clone.
virtual ~distributionModel ()=default
 Destructor.
virtual scalar sample () const =0
 Sample the distribution.
virtual scalar minValue () const
 Return the minimum of the distribution.
virtual scalar maxValue () const
 Return the maximum of the distribution.
virtual scalar meanValue () const =0
 Return the theoretical mean of the distribution, or the arithmetic mean of the distribution data.

Static Public Member Functions

static autoPtr< distributionModel > New (const dictionary &dict, Random &rndGen)
 Selector.

Protected Member Functions

virtual void check () const
 Check that the distribution model is valid.

Protected Attributes

const dictionary distributionModelDict_
 Coefficients dictionary.
Random & rndGen_
 Reference to the random number generator.
scalar minValue_
 Minimum of the distribution.
scalar maxValue_
 Maximum of the distribution.

Detailed Description

A library of runtime-selectable doubly-truncated probability distribution models. Returns random samples based on given distribution parameters.

Available distribution models include:

  • binned
  • exponential
  • fixedValue
  • general
  • multi-normal
  • normal
  • Rosin-Rammler
  • Mass-based Rosin-Rammler
  • uniform
Source files

Definition at line 69 of file distributionModel.H.

Constructor & Destructor Documentation

◆ distributionModel() [1/2]

distributionModel ( const word & name,
const dictionary & dict,
Random & rndGen )

Construct from dictionary.

Definition at line 70 of file distributionModel.C.

References dict, distributionModelDict_, maxValue_, minValue_, Foam::name(), rndGen, and rndGen_.

Referenced by binned::binned(), binned::binned(), binned::binned(), declareRunTimeSelectionTable(), distributionModel(), exponential::exponential(), exponential::exponential(), fixedValue::fixedValue(), fixedValue::fixedValue(), general::general(), general::general(), general::general(), massRosinRammler::massRosinRammler(), massRosinRammler::massRosinRammler(), multiNormal::multiNormal(), multiNormal::multiNormal(), normal::normal(), normal::normal(), RosinRammler::RosinRammler(), RosinRammler::RosinRammler(), uniform::uniform(), and uniform::uniform().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ distributionModel() [2/2]

distributionModel ( const distributionModel & p)

Copy construct.

Definition at line 84 of file distributionModel.C.

References distributionModel(), distributionModelDict_, maxValue_, minValue_, p, and rndGen_.

Here is the call graph for this function:

◆ ~distributionModel()

virtual ~distributionModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ check()

void check ( ) const
protectedvirtual

Check that the distribution model is valid.

Definition at line 35 of file distributionModel.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, maxValue(), minValue(), Foam::nl, Foam::type(), and WarningInFunction.

Referenced by binned::binned(), exponential::exponential(), general::general(), and uniform::uniform().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TypeName()

TypeName ( "distributionModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr ,
distributionModel ,
dictionary ,
(const dictionary &dict, Random &rndGen) ,
(dict, rndGen)  )

Declare runtime constructor selection table.

References dict, distributionModel(), Foam::name(), p, and rndGen.

Here is the call graph for this function:

◆ clone()

virtual autoPtr< distributionModel > clone ( ) const
pure virtual

Construct and return a clone.

Implemented in binned, exponential, fixedValue, general, massRosinRammler, multiNormal, normal, RosinRammler, and uniform.

References dict, and rndGen.

◆ New()

Foam::autoPtr< Foam::distributionModel > New ( const dictionary & dict,
Random & rndGen )
static

Selector.

Definition at line 26 of file distributionModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and rndGen.

Here is the call graph for this function:

◆ sample()

virtual scalar sample ( ) const
pure virtual

Sample the distribution.

Implemented in binned, exponential, fixedValue, general, massRosinRammler, multiNormal, normal, RosinRammler, and uniform.

◆ minValue()

Foam::scalar minValue ( ) const
virtual

Return the minimum of the distribution.

Reimplemented in fixedValue.

Definition at line 98 of file distributionModel.C.

References minValue_.

Referenced by check().

Here is the caller graph for this function:

◆ maxValue()

Foam::scalar maxValue ( ) const
virtual

Return the maximum of the distribution.

Reimplemented in fixedValue.

Definition at line 104 of file distributionModel.C.

References maxValue_.

Referenced by check().

Here is the caller graph for this function:

◆ meanValue()

virtual scalar meanValue ( ) const
pure virtual

Return the theoretical mean of the distribution, or the arithmetic mean of the distribution data.

Implemented in binned, exponential, fixedValue, general, massRosinRammler, multiNormal, normal, RosinRammler, and uniform.

Member Data Documentation

◆ distributionModelDict_

const dictionary distributionModelDict_
protected

Coefficients dictionary.

Definition at line 78 of file distributionModel.H.

Referenced by binned::binned(), distributionModel(), distributionModel(), exponential::exponential(), fixedValue::fixedValue(), general::general(), massRosinRammler::massRosinRammler(), multiNormal::multiNormal(), normal::normal(), and RosinRammler::RosinRammler().

◆ rndGen_

Random& rndGen_
protected

Reference to the random number generator.

Definition at line 83 of file distributionModel.H.

Referenced by distributionModel(), distributionModel(), binned::sample(), exponential::sample(), general::sample(), massRosinRammler::sample(), multiNormal::sample(), multiNormal::sample(), normal::sample(), RosinRammler::sample(), and uniform::sample().

◆ minValue_

scalar minValue_
protected

Minimum of the distribution.

Definition at line 88 of file distributionModel.H.

Referenced by binned::binned(), binned::binned(), distributionModel(), distributionModel(), general::general(), general::general(), normal::meanValue(), RosinRammler::meanValue(), uniform::meanValue(), minValue(), exponential::sample(), massRosinRammler::sample(), multiNormal::sample(), normal::sample(), RosinRammler::sample(), and uniform::sample().

◆ maxValue_

scalar maxValue_
protected

Maximum of the distribution.

Definition at line 93 of file distributionModel.H.

Referenced by binned::binned(), binned::binned(), distributionModel(), distributionModel(), general::general(), general::general(), maxValue(), normal::meanValue(), RosinRammler::meanValue(), uniform::meanValue(), binned::sample(), exponential::sample(), massRosinRammler::sample(), multiNormal::sample(), normal::sample(), RosinRammler::sample(), and uniform::sample().

The documentation for this class was generated from the following files: