Public Member Functions | Protected Member Functions | List of all members
RosinRammler Class Reference

Rosin-Rammler distribution, scaled so that it spans between a specified minimum and maximum value, rather than from zero to infinity. More...

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

Public Member Functions

 TypeName ("RosinRammler")
 Runtime type information. More...
 
 RosinRammler (const dictionary &dict, Random &rndGen, const label sampleQ)
 Construct from a dictionary. More...
 
 RosinRammler (const RosinRammler &d, const label sampleQ)
 Construct copy. More...
 
virtual autoPtr< distribution > clone (const label sampleQ) const
 Construct and return a clone. More...
 
virtual ~RosinRammler ()
 Destructor. More...
 
virtual scalar sample () const
 Sample the distribution. More...
 
virtual scalar min () const
 Return the minimum value. More...
 
virtual scalar max () const
 Return the maximum value. More...
 
virtual tmp< scalarField > x (const label n) const
 Return coordinates to plot across the range of the distribution. More...
 
- Public Member Functions inherited from FieldDistribution< unintegrableForNonZeroQ, RosinRammler >
virtual tmp< scalarField > sample (const label n) const
 Sample the distribution. More...
 

Protected Member Functions

virtual tmp< scalarField > phi (const label q, const scalarField &x) const
 Return values of the un-normalised PDF for the given size exponent. More...
 
virtual tmp< scalarField > Phi (const label q, const scalarField &x) const
 Return values of the un-normalised CDF for the given size exponent. More...
 

Detailed Description

Rosin-Rammler distribution, scaled so that it spans between a specified minimum and maximum value, rather than from zero to infinity.

\[ PDF(x) = \left( \frac{n}{d} \right) \left( \frac{x}{d} \right)^{n-1} \exp \left( - \left(\frac{x}{d} \right)^n \right) \]

\[ CDF(x) = 1 - \exp \left( - \left( \frac{x}{d} \right)^n \right) \]

Usage
Example usage: 
{
    type    RosinRammler;
    Q       0;
    min     0.00001;
    max     0.00015;
    d       0.00014;
    n       2;
}
Source files
See also
Foam::distribution

Definition at line 74 of file RosinRammler.H.

Constructor & Destructor Documentation

◆ RosinRammler() [1/2]

RosinRammler ( const dictionary &  dict,
Random &  rndGen,
const label  sampleQ 
)

Construct from a dictionary.

Definition at line 74 of file RosinRammler.C.

Referenced by RosinRammler::clone().

Here is the caller graph for this function:

◆ RosinRammler() [2/2]

RosinRammler ( const RosinRammler &  d,
const label  sampleQ 
)

Construct copy.

Definition at line 100 of file RosinRammler.C.

◆ ~RosinRammler()

~RosinRammler ( )
virtual

Destructor.

Definition at line 116 of file RosinRammler.C.

Member Function Documentation

◆ phi()

Foam::tmp< Foam::scalarField > phi ( const label  q,
const scalarField &  x 
) const
protectedvirtual

Return values of the un-normalised PDF for the given size exponent.

and x-coordinates.

Definition at line 43 of file RosinRammler.C.

References Foam::exp(), Foam::integerPow(), Foam::pow(), and RosinRammler::x().

Here is the call graph for this function:

◆ Phi()

Foam::tmp< Foam::scalarField > Phi ( const label  q,
const scalarField &  x 
) const
protectedvirtual

Return values of the un-normalised CDF for the given size exponent.

and x-coordinates.

Definition at line 55 of file RosinRammler.C.

References Foam::exp(), unintegrable::Phi(), Foam::pow(), and x.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "RosinRammler"  )

Runtime type information.

◆ clone()

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

Construct and return a clone.

Definition at line 134 of file RosinRammler.H.

References RosinRammler::RosinRammler().

Here is the call graph for this function:

◆ sample()

Foam::scalar sample ( ) const
virtual

Sample the distribution.

Definition at line 122 of file RosinRammler.C.

References Foam::log(), Foam::pow(), s(), and unintegrable::sample().

Here is the call graph for this function:

◆ min()

Foam::scalar min ( ) const
virtual

Return the minimum value.

Definition at line 138 of file RosinRammler.C.

◆ max()

Foam::scalar max ( ) const
virtual

Return the maximum value.

Definition at line 144 of file RosinRammler.C.

◆ x()

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

Return coordinates to plot across the range of the distribution.

Definition at line 151 of file RosinRammler.C.

References Foam::max(), n, tmp< T >::ref(), and distribution::x().

Referenced by RosinRammler::phi().

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files: