FreeFOAM The Cross-Platform CFD Toolkit
pdf Class Reference

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


Detailed Description

Definition at line 70 of file pdf.H.

+ Inheritance diagram for pdf:
+ Collaboration diagram for pdf:

List of all members.

Public Member Functions

 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.
virtual scalar sample () const =0
 Sample the pdf.
virtual scalar minValue () const =0
 Return the minimum value.
virtual scalar maxValue () const =0
 Return the maximum value.

Static Public Member Functions

static autoPtr< pdfNew (const dictionary &dict, Random &rndGen)
 Selector.

Protected Member Functions

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

Protected Attributes

const dictionary pdfDict_
 Coefficients dictionary.
RandomrndGen_
 Reference to the randmo number generator.

Constructor & Destructor Documentation

pdf ( const word name,
const dictionary dict,
Random rndGen 
)

Construct from dictionary.

Definition at line 64 of file pdf.C.

~pdf ( )
virtual

Destructor.

Definition at line 73 of file pdf.C.


Member Function Documentation

void check ( ) const
protectedvirtual
TypeName ( "pdf"  )

Runtime type information.

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

Declare runtime constructor selection table.

Foam::autoPtr< Foam::pdfs::pdf > New ( const dictionary dict,
Random rndGen 
)
static

Selector.

Definition at line 31 of file pdfNew.C.

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

virtual scalar sample ( ) const
pure virtual

Sample the pdf.

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

virtual scalar minValue ( ) const
pure virtual

Return the minimum value.

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

Referenced by pdf::check().

virtual scalar maxValue ( ) const
pure virtual

Return the maximum value.

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

Referenced by pdf::check().


Member Data Documentation

const dictionary pdfDict_
protected

Coefficients dictionary.

Definition at line 78 of file pdf.H.

Random& rndGen_
protected

Reference to the randmo number generator.

Definition at line 81 of file pdf.H.


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