FreeFOAM The Cross-Platform CFD Toolkit
exponential Class Reference

#include <src/thermophysicalModels/pdfs/exponential/exponential.H>


Detailed Description

Definition at line 51 of file exponential.H.

+ Inheritance diagram for exponential:
+ Collaboration diagram for exponential:

List of all members.

Public Member Functions

 TypeName ("exponential")
 Runtime type information.
 exponential (const dictionary &dict, Random &rndGen)
 Construct from components.
virtual ~exponential ()
 Destructor.
virtual scalar sample () const
 Sample the pdf.
virtual scalar minValue () const
 Return the minimum value.
virtual scalar maxValue () const
 Return the maximum value.
- Public Member Functions inherited from pdf
 TypeName ("pdf")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, pdf, dictionary,(const dictionary &dict, Random &rndGen),(dict, rndGen))
 Declare runtime constructor selection table.
 pdf (const word &name, const dictionary &dict, Random &rndGen)
 Construct from dictionary.
virtual ~pdf ()
 Destructor.

Additional Inherited Members

- Static Public Member Functions inherited from pdf
static autoPtr< pdfNew (const dictionary &dict, Random &rndGen)
 Selector.
- Protected Member Functions inherited from pdf
virtual void check () const
 Check that the PDF is valid.
- Protected Attributes inherited from pdf
const dictionary pdfDict_
 Coefficients dictionary.
RandomrndGen_
 Reference to the randmo number generator.

Constructor & Destructor Documentation

exponential ( const dictionary dict,
Random rndGen 
)

Construct from components.

Definition at line 42 of file exponential.C.

References pdf::check().

~exponential ( )
virtual

Destructor.

Definition at line 55 of file exponential.C.


Member Function Documentation

TypeName ( "exponential"  )

Runtime type information.

Foam::scalar sample ( ) const
virtual

Sample the pdf.

Implements pdf.

Definition at line 61 of file exponential.C.

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

Foam::scalar minValue ( ) const
virtual

Return the minimum value.

Implements pdf.

Definition at line 69 of file exponential.C.

Foam::scalar maxValue ( ) const
virtual

Return the maximum value.

Implements pdf.

Definition at line 75 of file exponential.C.


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