fixedValue Class Reference

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

Inheritance diagram for fixedValue:

Collaboration diagram for fixedValue:

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< distributionModel >	clone () 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	~distributionModel ()=default
	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...
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

• fixedValue.H
• fixedValue.C

Definition at line 104 of file fixedValue.H.

Constructor & Destructor Documentation

fixedValue() [1/2]

fixedValue	(	const dictionary &	dict,
		Random &	rndGen
	)

Construct from components.

Definition at line 39 of file fixedValue.C.

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

Referenced by fixedValue::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

fixedValue() [2/2]

fixedValue

(

const fixedValue &

p

)

Copy construct.

Definition at line 57 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 139 of file fixedValue.H.

References fixedValue::fixedValue().

Here is the call graph for this function:

operator=()

void operator= ( const fixedValue &  )

delete

No copy assignment.

sample()

virtual scalar sample ( ) const

virtual

Sample the distribution.

Implements distributionModel.

minValue()

virtual scalar minValue ( ) const

virtual

Return the minimum of the distribution.

Reimplemented from distributionModel.

maxValue()

virtual scalar maxValue ( ) const

virtual

Return the maximum of the distribution.

Reimplemented from distributionModel.

meanValue()

virtual scalar meanValue ( ) const

virtual

Return the theoretical mean of the distribution.

Implements distributionModel.

---

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

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