Particle-size distribution model wherein random samples are drawn from a given discrete set of (bin, probability) pairs, where in terms of its meaning, bins correspond to particle sizes and probabilities correspond to (relative) probability of occurrences. More...

#include <binned.H>

Inheritance diagram for binned:

[legend]

Collaboration diagram for binned:

[legend]

Public Member Functions
	TypeName ("binned")
	Runtime type information.
	binned (const dictionary &dict, Random &rndGen)
	Construct from dictionary.
	binned (const UList< scalar > &sampleData, const scalar binWidth, Random &rndGen)
	Construct from components.
	binned (const binned &p)
	Copy construct.
virtual autoPtr< distributionModel >	clone () const
	Construct and return a clone.
void	operator= (const binned &)=delete
	No copy assignment.
virtual	~binned ()=default
	Destructor.
virtual scalar	sample () const
	Sample the distribution.
virtual scalar	meanValue () const
	Return the arithmetic mean of the distribution data.
virtual void	writeData (Ostream &os) const
	Write data to stream.
virtual void	readData (Istream &os)
	Read data from stream.
virtual dictionary	writeDict (const word &dictName) const
	Write data in dictionary format.
virtual void	readDict (const dictionary &dict)
	Read data from dictionary.
Public Member Functions inherited from distributionModel
	TypeName ("distributionModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, distributionModel, dictionary,(const dictionary &dict, Random &rndGen),(dict, rndGen))
	Declare runtime constructor selection table.
	distributionModel (const word &name, const dictionary &dict, Random &rndGen)
	Construct from dictionary.
	distributionModel (const distributionModel &p)
	Copy construct.
virtual	~distributionModel ()=default
	Destructor.
virtual scalar	minValue () const
	Return the minimum of the distribution.
virtual scalar	maxValue () const
	Return the maximum of the distribution.

Static Public Attributes
static const char *	header

Additional Inherited Members
Static Public Member Functions inherited from distributionModel
static autoPtr< distributionModel >	New (const dictionary &dict, Random &rndGen)
	Selector.
Protected Member Functions inherited from distributionModel
virtual void	check () const
	Check that the distribution model is valid.
Protected Attributes inherited from distributionModel
const dictionary	distributionModelDict_
	Coefficients dictionary.
Random &	rndGen_
	Reference to the random number generator.
scalar	minValue_
	Minimum of the distribution.
scalar	maxValue_
	Maximum of the distribution.

Detailed Description

Particle-size distribution model wherein random samples are drawn from a given discrete set of (bin, probability) pairs, where in terms of its meaning, bins correspond to particle sizes and probabilities correspond to (relative) probability of occurrences.

The second column (i.e. probability) are normalised by the sum of all its values, resulting in a normalised column in the domain of [0,1]. To generate a sample, first a sample drawn from the uniform probability density function on the unit interval (i.e. u), and then, the bin corresponding to the first probability larger than u is fetched as the particle size to be further processed.

Usage

Minimal example by using constant/<CloudProperties>:

subModels
{
    injectionModels
    {
        <name>
        {
            ...

            sizeDistribution
            {
                type        binned;
                binnedDistribution
                {
                    distribution
                    (
                        (<bin1>    <probability1>)
                        (<bin2>    <probability2>)
                        ...
                        (<binN>    <probabilityN>)
                    );
                }
            }
        }
    }
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: binned	word	yes	-
`binnedDistribution`	Distribution settings	dict	yes	-
`distribution`	<bin>-<probability> pairs	dict	yes	-
`<bin>`	Particle size	scalar	yes	-
`<probability>`	Probability of occurrence	scalar	yes	-

Source files

Definition at line 146 of file binned.H.

Constructor & Destructor Documentation

◆ binned() [1/3]

binned	(	const dictionary &	dict,
		Random &	rndGen )

Construct from dictionary.

Definition at line 86 of file binned.C.

References distributionModel::check(), dict, distributionModel::distributionModel(), distributionModel::distributionModelDict_, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, distributionModel::maxValue_, distributionModel::minValue_, and rndGen.

Referenced by binned(), clone(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ binned() [2/3]

binned	(	const UList< scalar > &	sampleData,
		const scalar	binWidth,
		Random &	rndGen )

Construct from components.

Allows negative entries

Definition at line 105 of file binned.C.

References distributionModel::distributionModel(), Foam::endl(), forAll, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, Foam::mag(), Foam::max(), distributionModel::maxValue_, Foam::min(), distributionModel::minValue_, Foam::nl, rndGen, and WarningInFunction.

Here is the call graph for this function:

◆ binned() [3/3]

binned ( const binned & p )

Copy construct.

Definition at line 171 of file binned.C.

References binned(), distributionModel::distributionModel(), and p.

Here is the call graph for this function:

◆ ~binned()

virtual ~binned ( )

virtualdefault

Destructor.

References dict, dictName(), and os().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "binned" )

Runtime type information.

◆ clone()

virtual autoPtr< distributionModel > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements distributionModel.

Definition at line 208 of file binned.H.

References binned().

Here is the call graph for this function:

◆ operator=()

void operator= ( const binned & )

delete

No copy assignment.

References binned().

Here is the call graph for this function:

◆ sample()

Foam::scalar sample ( ) const

virtual

Sample the distribution.

Implements distributionModel.

Definition at line 181 of file binned.C.

References distributionModel::maxValue_, and distributionModel::rndGen_.

◆ meanValue()

Foam::scalar meanValue ( ) const

virtual

Return the arithmetic mean of the distribution data.

Implements distributionModel.

Definition at line 197 of file binned.C.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write data to stream.

Definition at line 210 of file binned.C.

References os().

Here is the call graph for this function:

◆ readData()

void readData ( Istream & os )

virtual

Read data from stream.

Definition at line 203 of file binned.C.

◆ writeDict()

Foam::dictionary writeDict ( const word & dictName ) const

virtual

Write data in dictionary format.

Definition at line 217 of file binned.C.

References dict, and dictName().

Here is the call graph for this function:

◆ readDict()

void readDict ( const dictionary & dict )

virtual

Read data from dictionary.

Definition at line 230 of file binned.C.

References dict.

Member Data Documentation

◆ header

const char * header

static

Initial value:

=

"(bin probability)"

Definition at line 178 of file binned.H.

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

src/lagrangian/distributionModels/binned/binned.H
src/lagrangian/distributionModels/binned/binned.C

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ binned() [1/3]

◆ binned() [2/3]

◆ binned() [3/3]

◆ ~binned()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ operator=()

◆ sample()

◆ meanValue()

◆ writeData()

◆ readData()

◆ writeDict()

◆ readDict()

Member Data Documentation

◆ header