Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
distributionModel Class Referenceabstract
Inheritance diagram for distributionModel:
Inheritance graph
[legend]
Collaboration diagram for distributionModel:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("distributionModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, distributionModel, dictionary,( const dictionary &dict, cachedRandom &rndGen ),(dict, rndGen))
 Declare runtime constructor selection table. More...
 
 distributionModel (const word &name, const dictionary &dict, cachedRandom &rndGen)
 Construct from dictionary. More...
 
 distributionModel (const distributionModel &p)
 Construct copy. More...
 
virtual autoPtr< distributionModelclone () const =0
 Construct and return a clone. More...
 
virtual ~distributionModel ()
 Destructor. More...
 
virtual scalar sample () const =0
 Sample the distributionModel. More...
 
virtual scalar minValue () const =0
 Return the minimum value. More...
 
virtual scalar maxValue () const =0
 Return the maximum value. More...
 
virtual scalar meanValue () const =0
 Return the maximum value. More...
 

Static Public Member Functions

static autoPtr< distributionModelNew (const dictionary &dict, cachedRandom &rndGen)
 Selector. More...
 

Protected Member Functions

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

Protected Attributes

const dictionary distributionModelDict_
 Coefficients dictionary. More...
 
cachedRandomrndGen_
 Reference to the random number generator. More...
 

Detailed Description

Definition at line 69 of file distributionModel.H.

Constructor & Destructor Documentation

distributionModel ( const word name,
const dictionary dict,
cachedRandom rndGen 
)

Construct from dictionary.

Definition at line 66 of file distributionModel.C.

Referenced by distributionModel::check().

Here is the caller graph for this function:

Construct copy.

Definition at line 78 of file distributionModel.C.

~distributionModel ( )
virtual

Destructor.

Definition at line 89 of file distributionModel.C.

Member Function Documentation

void check ( ) const
protectedvirtual

Check that the distribution model is valid.

Definition at line 42 of file distributionModel.C.

References Foam::abort(), distributionModel::distributionModel(), Foam::FatalError, FatalErrorIn, maxValue, minValue, Foam::nl, and Foam::type().

Here is the call graph for this function:

TypeName ( "distributionModel"  )

Runtime type information.

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

Declare runtime constructor selection table.

virtual autoPtr<distributionModel> clone ( ) const
pure virtual

Construct and return a clone.

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

Foam::autoPtr< Foam::distributionModels::distributionModel > New ( const dictionary dict,
cachedRandom rndGen 
)
static

Selector.

Definition at line 32 of file distributionModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), Foam::nl, and rndGen().

Here is the call graph for this function:

virtual scalar sample ( ) const
pure virtual
virtual scalar minValue ( ) const
pure virtual

Return the minimum value.

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

virtual scalar maxValue ( ) const
pure virtual

Return the maximum value.

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

virtual scalar meanValue ( ) const
pure virtual

Return the maximum value.

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

Member Data Documentation

const dictionary distributionModelDict_
protected

Coefficients dictionary.

Definition at line 77 of file distributionModel.H.

cachedRandom& rndGen_
protected

Reference to the random number generator.

Definition at line 80 of file distributionModel.H.

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


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