multiNormal Class Reference

A multiNormal distribution model. More...

Inheritance diagram for multiNormal:

Collaboration diagram for multiNormal:

Public Member Functions
	TypeName ("multiNormal")
	Runtime type information. More...
	multiNormal (const dictionary &dict, Random &rndGen)
	Construct from components. More...
	multiNormal (const multiNormal &p)
	Construct copy. More...
virtual autoPtr< distributionModel >	clone () const
	Construct and return a clone. More...
virtual	~multiNormal ()
	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, Random &rndGen),(dict, rndGen))
	Declare runtime constructor selection table. More...
	distributionModel (const word &name, const dictionary &dict, Random &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< distributionModel >	New (const dictionary &dict, Random &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...
Random &	rndGen_
	Reference to the random number generator. More...

Detailed Description

A multiNormal distribution model.

    model = sum_i strength_i * exp(-0.5*((x - expectation_i)/variance_i)^2 )

Source files

• multiNormal.H
• multiNormal.C

Definition at line 57 of file multiNormal.H.

Constructor & Destructor Documentation

multiNormal() [1/2]

multiNormal	(	const dictionary &	dict,
		Random &	rndGen
	)

Construct from components.

Definition at line 45 of file multiNormal.C.

References Foam::exp(), Foam::max(), n, s, x, and y.

Referenced by multiNormal::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

multiNormal() [2/2]

multiNormal

(

const multiNormal &

p

)

Construct copy.

Definition at line 86 of file multiNormal.C.

~multiNormal()

~multiNormal ( )

virtual

Destructor.

Definition at line 100 of file multiNormal.C.

Member Function Documentation

TypeName()

TypeName

(

"multiNormal"

)

Runtime type information.

clone()

virtual autoPtr<distributionModel> clone ( ) const

inlinevirtual

Construct and return a clone.

Implements distributionModel.

Definition at line 95 of file multiNormal.H.

References multiNormal::multiNormal().

Here is the call graph for this function:

sample()

Foam::scalar sample ( ) const

virtual

Sample the distributionModel.

Implements distributionModel.

Definition at line 106 of file multiNormal.C.

References Foam::exp(), n, nu, p, s, sigma(), success, 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 138 of file multiNormal.C.

maxValue()

Foam::scalar maxValue ( ) const

virtual

Return the maximum value.

Implements distributionModel.

Definition at line 144 of file multiNormal.C.

meanValue()

Foam::scalar meanValue ( ) const

virtual

Return the mean value.

Implements distributionModel.

Definition at line 150 of file multiNormal.C.

References forAll.

---

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

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