exponential Class Reference
Inheritance diagram for exponential:
Collaboration diagram for exponential:

Public Member Functions

 TypeName ("exponential")
 Runtime type information. More...
 
 exponential (const dictionary &dict, cachedRandom &rndGen)
 Construct from components. More...
 
 exponential (const exponential &p)
 Construct copy. More...
 
virtual autoPtr
< distributionModel
clone () const
 Construct and return a clone. More...
 
virtual ~exponential ()
 Destructor. More...
 
virtual scalar sample () const
 Sample the distributionModel. More...
 
virtual scalar minValue () const
 Return the minimum value. More...
 
virtual scalar maxValue () const
 Return the maximum value. More...
 
virtual scalar meanValue () const
 Return the mean value. More...
 
- Public Member Functions inherited from distributionModel
 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 ~distributionModel ()
 Destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from distributionModel
static autoPtr< distributionModelNew (const dictionary &dict, cachedRandom &rndGen)
 Selector. More...
 
- Protected Member Functions inherited from distributionModel
virtual void check () const
 Check that the distribution model is valid. More...
 
- Protected Attributes inherited from distributionModel
const dictionary distributionModelDict_
 Coefficients dictionary. More...
 
cachedRandomrndGen_
 Reference to the random number generator. More...
 

Detailed Description

Definition at line 51 of file exponential.H.

Constructor & Destructor Documentation

exponential ( const dictionary dict,
cachedRandom rndGen 
)

Construct from components.

Definition at line 43 of file exponential.C.

Referenced by exponential::clone().

Here is the caller graph for this function:

exponential ( const exponential p)

Construct copy.

Definition at line 57 of file exponential.C.

~exponential ( )
virtual

Destructor.

Definition at line 68 of file exponential.C.

Member Function Documentation

TypeName ( "exponential"  )

Runtime type information.

virtual autoPtr<distributionModel> clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from distributionModel.

Definition at line 84 of file exponential.H.

References exponential::exponential().

Here is the call graph for this function:

Foam::scalar sample ( ) const
virtual

Sample the distributionModel.

Reimplemented from distributionModel.

Definition at line 74 of file exponential.C.

References Foam::exp(), Foam::log(), and y.

Here is the call graph for this function:

Foam::scalar minValue ( ) const
virtual

Return the minimum value.

Reimplemented from distributionModel.

Definition at line 82 of file exponential.C.

Foam::scalar maxValue ( ) const
virtual

Return the maximum value.

Reimplemented from distributionModel.

Definition at line 88 of file exponential.C.

Foam::scalar meanValue ( ) const
virtual

Return the mean value.

Reimplemented from distributionModel.

Definition at line 94 of file exponential.C.


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