Public Member Functions | List of all members
multiNormal Class Reference

Multiple superimposed normal distributions. More...

Inheritance diagram for multiNormal:
Inheritance graph
[legend]
Collaboration diagram for multiNormal:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("multiNormal")
 Runtime type information. More...
 
 multiNormal (const unitConversion &units, const dictionary &dict, const label sampleQ, randomGenerator &&rndGen)
 Construct from a dictionary. More...
 
 multiNormal (const multiNormal &d, const label sampleQ)
 Construct copy. More...
 
virtual autoPtr< distribution > clone (const label sampleQ) const
 Construct and return a clone. More...
 
virtual ~multiNormal ()
 Destructor. More...
 
virtual scalar sampleForZeroQ () const
 Sample the distribution for zero effective size exponent. More...
 
virtual scalar min () const
 Return the minimum value. More...
 
virtual scalar max () const
 Return the maximum value. More...
 
virtual void write (Ostream &os, const unitConversion &units) const
 Write stream. More...
 
virtual tmp< scalarField > plotX (const label n) const
 Return coordinates to plot across the range of the distribution. More...
 
- Public Member Functions inherited from FieldDistribution< unintegrableForNonZeroQ, multiNormal >
Type sample () const
 Sample the distribution into components of a primitive type. More...
 
virtual tmp< scalarField > sample (const label n) const
 Sample the distribution into a field. More...
 

Additional Inherited Members

- Protected Member Functions inherited from FieldDistribution< unintegrableForNonZeroQ, multiNormal >
 FOR_ALL_FIELD_TYPES (VIRTUAL_SAMPLE_TYPE)
 

Detailed Description

Multiple superimposed normal distributions.

\[ PDF(x) = \sum_i S_i \frac{1}{\sigma_i \sqrt{2 \pi}} \exp \left( \frac{1}{2} \left( \frac{x - \mu_i}{\sigma_i} \right)^2 \right) \]

Usage
Example usage: 
{
    type    multiNormal;
    Q       0;
    min     0.001;
    max     0.019;
    mu      (0.005 0.011 0.015);
    sigma   (0.002 0.001 0.0015);
    strength (2 1 3);
}
Source files
See also
Foam::distribution Foam::distributions::normal

Definition at line 72 of file multiNormal.H.

Constructor & Destructor Documentation

◆ multiNormal() [1/2]

multiNormal ( const unitConversion &  units,
const dictionary &  dict,
const label  sampleQ,
randomGenerator &&  rndGen 
)

Construct from a dictionary.

Definition at line 105 of file multiNormal.C.

References Foam::abort(), dict, Foam::FatalIOError, FatalIOErrorInFunction, forAll, multiNormal::max(), multiNormal::min(), Foam::constant::physicoChemical::mu, Foam::nl, Foam::constant::physicoChemical::sigma, List< T >::size(), Foam::type(), and Foam::units().

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 &  d,
const label  sampleQ 
)

Construct copy.

Definition at line 179 of file multiNormal.C.

References forAll.

◆ ~multiNormal()

~multiNormal ( )
virtual

Destructor.

Definition at line 212 of file multiNormal.C.

Member Function Documentation

◆ TypeName()

TypeName ( "multiNormal"  )

Runtime type information.

◆ clone()

virtual autoPtr<distribution> clone ( const label  sampleQ) const
inlinevirtual

Construct and return a clone.

Definition at line 124 of file multiNormal.H.

References multiNormal::multiNormal().

Here is the call graph for this function:

◆ sampleForZeroQ()

Foam::scalar sampleForZeroQ ( ) const
virtual

Sample the distribution for zero effective size exponent.

Definition at line 218 of file multiNormal.C.

References Foam::fvm::S(), and s().

Here is the call graph for this function:

◆ min()

Foam::scalar min ( ) const
virtual

Return the minimum value.

Definition at line 239 of file multiNormal.C.

Referenced by multiNormal::multiNormal().

Here is the caller graph for this function:

◆ max()

Foam::scalar max ( ) const
virtual

Return the maximum value.

Definition at line 245 of file multiNormal.C.

Referenced by multiNormal::multiNormal().

Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os,
const unitConversion &  units 
) const
virtual

Write stream.

Definition at line 251 of file multiNormal.C.

References forAll, Foam::max(), Foam::min(), Foam::constant::physicoChemical::mu, Foam::constant::physicoChemical::sigma, Foam::units(), Foam::vtkWriteOps::write(), and Foam::writeEntry().

Here is the call graph for this function:

◆ plotX()

Foam::tmp< Foam::scalarField > plotX ( const label  n) const
virtual

Return coordinates to plot across the range of the distribution.

Definition at line 275 of file multiNormal.C.

References n.

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