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< distributionModelclone () 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< distributionModelNew (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...
 
RandomrndGen_
 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

Definition at line 55 of file multiNormal.H.

Constructor & Destructor Documentation

◆ multiNormal() [1/2]

multiNormal ( const dictionary dict,
Random rndGen 
)

Construct from components.

Definition at line 43 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 84 of file multiNormal.C.

◆ ~multiNormal()

~multiNormal ( )
virtual

Destructor.

Definition at line 98 of file multiNormal.C.

Referenced by multiNormal::clone().

Here is the caller graph for this function:

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 93 of file multiNormal.H.

References multiNormal::maxValue(), multiNormal::meanValue(), multiNormal::minValue(), multiNormal::multiNormal(), multiNormal::sample(), and multiNormal::~multiNormal().

Here is the call graph for this function:

◆ sample()

Foam::scalar sample ( ) const
virtual

Sample the distributionModel.

Implements distributionModel.

Definition at line 104 of file multiNormal.C.

References Foam::exp(), n, nu, p, distributionModel::rndGen_, s(), Random::sample01(), Foam::constant::physicoChemical::sigma, List< T >::size(), success, x, and y.

Referenced by multiNormal::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ minValue()

Foam::scalar minValue ( ) const
virtual

Return the minimum value.

Implements distributionModel.

Definition at line 136 of file multiNormal.C.

Referenced by multiNormal::clone().

Here is the caller graph for this function:

◆ maxValue()

Foam::scalar maxValue ( ) const
virtual

Return the maximum value.

Implements distributionModel.

Definition at line 142 of file multiNormal.C.

Referenced by multiNormal::clone().

Here is the caller graph for this function:

◆ meanValue()

Foam::scalar meanValue ( ) const
virtual

Return the mean value.

Implements distributionModel.

Definition at line 148 of file multiNormal.C.

References forAll.

Referenced by multiNormal::clone().

Here is the caller graph for this function:

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