fixedValue Class Reference

Particle-size distribution model wherein samples are given fixed values. More...

Inheritance diagram for fixedValue:
[legend]
Collaboration diagram for fixedValue:
[legend]

Public Member Functions

 TypeName ("fixedValue")
 Runtime type information. More...
 
 fixedValue (const dictionary &dict, Random &rndGen)
 Construct from components. More...
 
 fixedValue (const fixedValue &p)
 Copy construct. More...
 
virtual autoPtr< distributionModelclone () const
 Construct and return a clone. More...
 
void operator= (const fixedValue &)=delete
 No copy assignment. More...
 
virtual ~fixedValue ()=default
 Destructor. More...
 
virtual scalar sample () const
 Sample the distribution. More...
 
virtual scalar minValue () const
 Return the minimum of the distribution. More...
 
virtual scalar maxValue () const
 Return the maximum of the distribution. More...
 
virtual scalar meanValue () const
 Return the theoretical mean of the distribution. 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)
 Copy construct. More...
 
virtual autoPtr< distributionModelclone () const =0
 Construct and return a clone. More...
 
virtual ~distributionModel ()=default
 Destructor. More...
 
virtual scalar sample () const =0
 Sample the distribution. More...
 
virtual scalar minValue () const
 Return the minimum of the distribution. More...
 
virtual scalar maxValue () const
 Return the maximum of the distribution. More...
 
virtual scalar meanValue () const =0
 

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...
 
scalar minValue_
 Minimum of the distribution. More...
 
scalar maxValue_
 Maximum of the distribution. More...
 

Detailed Description

Particle-size distribution model wherein samples are given fixed values.

Usage
Minimal example by using constant/<CloudProperties>:
subModels
{
    injectionModels
    {
        <name>
        {
            ...

            sizeDistribution
            {
                type        fixedValue;
                fixedValueDistribution
                {
                    value   <value>;
                }
            }
        }
    }
}

where the entries mean:

Property Description Type Reqd Deflt
type Type name: fixedValue word yes -
fixedValueDistribution Distribution settings dict yes -
value Fixed value for size scalar yes -
Source files

Definition at line 108 of file fixedValue.H.

Constructor & Destructor Documentation

◆ fixedValue() [1/2]

fixedValue ( const dictionary dict,
Random rndGen 
)

Construct from components.

Definition at line 45 of file fixedValue.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Here is the call graph for this function:

◆ fixedValue() [2/2]

fixedValue ( const fixedValue p)

Copy construct.

Definition at line 64 of file fixedValue.C.

◆ ~fixedValue()

virtual ~fixedValue ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "fixedValue"  )

Runtime type information.

◆ clone()

virtual autoPtr< distributionModel > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements distributionModel.

Definition at line 133 of file fixedValue.H.

◆ operator=()

void operator= ( const fixedValue )
delete

No copy assignment.

◆ sample()

Foam::scalar sample ( ) const
virtual

Sample the distribution.

Implements distributionModel.

Definition at line 73 of file fixedValue.C.

◆ minValue()

Foam::scalar minValue ( ) const
virtual

Return the minimum of the distribution.

Reimplemented from distributionModel.

Definition at line 79 of file fixedValue.C.

◆ maxValue()

Foam::scalar maxValue ( ) const
virtual

Return the maximum of the distribution.

Reimplemented from distributionModel.

Definition at line 85 of file fixedValue.C.

◆ meanValue()

Foam::scalar meanValue ( ) const
virtual

Return the theoretical mean of the distribution.

Implements distributionModel.

Definition at line 91 of file fixedValue.C.


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