normal Class Reference

Inheritance diagram for normal:

Collaboration diagram for normal:

Public Member Functions
	TypeName ("normal")
	Runtime type information. More...
	normal (const dictionary &dict, cachedRandom &rndGen)
	Construct from components. More...
	normal (const normal &p)
	Construct copy. More...
virtual autoPtr< distributionModel >	clone () const
	Construct and return a clone. More...
virtual	~normal ()
	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...
virtual scalar	erfInv (const scalar y) const
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...

Private Attributes
scalar	minValue_
	Distribution minimum. More...
scalar	maxValue_
	Distribution maximum. More...
scalar	expectation_
scalar	variance_
scalar	a_

Additional Inherited Members
Static Public Member Functions inherited from distributionModel
static autoPtr< distributionModel >	New (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...
cachedRandom &	rndGen_
	Reference to the random number generator. More...

Detailed Description

Definition at line 56 of file normal.H.

Constructor & Destructor Documentation

normal() [1/2]

normal	(	const dictionary &	dict,
		cachedRandom &	rndGen
	)

Construct from components.

Definition at line 44 of file normal.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Referenced by normal::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

normal() [2/2]

normal

(

const normal &

p

)

Construct copy.

Definition at line 74 of file normal.C.

~normal()

~normal ( )

virtual

Destructor.

Definition at line 87 of file normal.C.

Member Function Documentation

TypeName()

TypeName

(

"normal"

)

Runtime type information.

clone()

virtual autoPtr<distributionModel> clone ( ) const

inlinevirtual

Construct and return a clone.

Implements distributionModel.

Definition at line 93 of file normal.H.

References normal::normal().

Here is the call graph for this function:

sample()

Foam::scalar sample ( ) const

virtual

Sample the distributionModel.

Implements distributionModel.

Definition at line 93 of file normal.C.

References Foam::constant::physicoChemical::b, Foam::erf(), Foam::max(), Foam::min(), x, and y.

Here is the call graph for this function:

minValue()

Foam::scalar minValue ( ) const

virtual

Return the minimum value.

Implements distributionModel.

Definition at line 111 of file normal.C.

maxValue()

Foam::scalar maxValue ( ) const

virtual

Return the maximum value.

Implements distributionModel.

Definition at line 117 of file normal.C.

meanValue()

Foam::scalar meanValue ( ) const

virtual

Return the mean value.

Implements distributionModel.

Definition at line 123 of file normal.C.

erfInv()

Foam::scalar erfInv ( const scalar  y ) const

virtual

Definition at line 129 of file normal.C.

References Foam::constant::universal::h, k, Foam::log(), Foam::constant::mathematical::pi(), Foam::sqrt(), x, and y.

Here is the call graph for this function:

Field Documentation

minValue_

scalar minValue_

private

Distribution minimum.

Definition at line 64 of file normal.H.

maxValue_

scalar maxValue_

private

Distribution maximum.

Definition at line 67 of file normal.H.

expectation_

scalar expectation_

private

Definition at line 72 of file normal.H.

variance_

scalar variance_

private

Definition at line 73 of file normal.H.

a_

scalar a_

private

Definition at line 75 of file normal.H.

---

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

• src/lagrangian/distributionModels/normal/normal.H
• src/lagrangian/distributionModels/normal/normal.C