Public Member Functions | List of all members
general Class Reference
Inheritance diagram for general:
Inheritance graph
[legend]
Collaboration diagram for general:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("general")
 Runtime type information. More...
 
 general (const dictionary &dict, cachedRandom &rndGen)
 Construct from components. More...
 
 general (const general &p)
 Construct copy. More...
 
virtual autoPtr< distributionModelclone () const
 Construct and return a clone. More...
 
virtual ~general ()
 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 52 of file general.H.

Constructor & Destructor Documentation

general ( const dictionary dict,
cachedRandom rndGen 
)

Construct from components.

Definition at line 43 of file general.C.

References k, Foam::y0(), and Foam::y1().

Referenced by general::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

general ( const general p)

Construct copy.

Definition at line 86 of file general.C.

~general ( )
virtual

Destructor.

Definition at line 99 of file general.C.

Referenced by general::clone().

Here is the caller graph for this function:

Member Function Documentation

TypeName ( "general"  )

Runtime type information.

virtual autoPtr<distributionModel> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements distributionModel.

Definition at line 88 of file general.H.

References general::general(), general::maxValue(), general::meanValue(), general::minValue(), general::sample(), and general::~general().

Here is the call graph for this function:

Foam::scalar sample ( ) const
virtual

Sample the distributionModel.

Implements distributionModel.

Definition at line 105 of file general.C.

References Foam::constant::atomic::alpha, k, Foam::mag(), n, p, distributionModel::rndGen_, cachedRandom::sample01(), Foam::sqrt(), x, and y.

Referenced by general::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar minValue ( ) const
virtual

Return the minimum value.

Implements distributionModel.

Definition at line 149 of file general.C.

Referenced by general::clone().

Here is the caller graph for this function:

Foam::scalar maxValue ( ) const
virtual

Return the maximum value.

Implements distributionModel.

Definition at line 155 of file general.C.

Referenced by general::clone().

Here is the caller graph for this function:

Foam::scalar meanValue ( ) const
virtual

Return the mean value.

Implements distributionModel.

Definition at line 161 of file general.C.

Referenced by general::clone().

Here is the caller graph for this function:


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