OpenFOAM logo
The Open Source CFD Toolbox
  Source Guide OpenCFD Solutions Contact OpenFOAM

normal Class Reference

A normal pdf. More...

Inheritance diagram for normal:
Collaboration diagram for normal:

List of all members.


Public Member Functions

 TypeName ("normal")
 Runtime type information.
 normal (const dictionary &dict, Random &rndGen)
 Construct from components.
virtual ~normal ()
 Destructor.
virtual scalar sample () const
 Sample the pdf.
virtual scalar minValue () const
 Return the minimum value.
virtual scalar maxValue () const
 Return the maximum value.

Detailed Description

A normal pdf.

    pdf = strength * exp(-0.5*((x - expectation)/variance)^2 )

strength only has meaning if there's more than one pdf

Source files

Definition at line 52 of file normal.H.


Constructor & Destructor Documentation

normal ( const dictionary dict,
Random rndGen 
)

Construct from components.

Definition at line 31 of file normal.C.

References Foam::addToRunTimeSelectionTable(), and Foam::defineTypeNameAndDebug().

Here is the call graph for this function:

~normal (  )  [virtual]

Destructor.

Definition at line 70 of file normal.C.


Member Function Documentation

TypeName ( "normal"   ) 

Runtime type information.

Foam::scalar sample (  )  const [virtual]

Sample the pdf.

Implements pdf.

Definition at line 76 of file normal.C.

Foam::scalar minValue (  )  const [virtual]

Return the minimum value.

Implements pdf.

Definition at line 108 of file normal.C.

Foam::scalar maxValue (  )  const [virtual]

Return the maximum value.

Implements pdf.

Definition at line 114 of file normal.C.


The documentation for this class was generated from the following files:
  • src/thermophysicalModels/pdfs/normal/normal.H
  • src/thermophysicalModels/pdfs/normal/normal.C
Copyright © 2000-2009 OpenCFD Ltd