Public Member Functions | List of all members
distributionDiameterLagrangianScalarFieldSource Class Reference

This source condition provides values of diameter randomly sampled from a given distribution. More...

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

Public Member Functions

 TypeName ("distributionDiameter")
 Runtime type information. More...
 
 distributionDiameterLagrangianScalarFieldSource (const regIOobject &, const dictionary &dict)
 Construct from internal field and dictionary. More...
 
 distributionDiameterLagrangianScalarFieldSource (const distributionDiameterLagrangianScalarFieldSource &, const regIOobject &)
 Copy constructor setting the internal field reference. More...
 
virtual autoPtr< LagrangianScalarFieldSource > clone (const regIOobject &iIo) const
 Construct and return a clone setting the internal field reference. More...
 
virtual ~distributionDiameterLagrangianScalarFieldSource ()
 Destructor. More...
 
virtual tmp< LagrangianSubScalarField > value (const LagrangianInjection &, const LagrangianSubMesh &) const
 Return the value for an instantaneous injection. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Detailed Description

This source condition provides values of diameter randomly sampled from a given distribution.

It is important to use this condition for diameter, rather than the generic distribution source condition, as this condition will account for the injection of parcels with differing numbers of particles when sampling the distribution. If the generic distribution source condition is used when injecting parcels of equal mass, for example, then the parcels containing many small particles will be over-represented in the sampling. This condition corrects for this and produces the correct distribution for whatever uniform size the number condition creates.

This condition must be used with parcel clouds and in conjunction with a condition for the number field that specifies a uniform size, such as flowRateNumber or totalNumber.

Usage
Property Description Required? Default
distribution The distribution yes

Example specification: 

    <LagrangianModelName>
    {
        type            distributionDiameter;
        distribution
        {
            type            RosinRammler;
            Q               0;
            min             0.1 [mm];
            max             1.5 [mm];
            d               1.4 [mm];
            n               2 [];
        }
    }
See also
Foam::distributions Foam::flowRateNumberLagrangianScalarFieldSource Foam::totalNumberLagrangianScalarFieldSource
Source files

Definition at line 101 of file distributionDiameterLagrangianScalarFieldSource.H.

Constructor & Destructor Documentation

◆ distributionDiameterLagrangianScalarFieldSource() [1/2]

distributionDiameterLagrangianScalarFieldSource ( const regIOobject &  iIo,
const dictionary &  dict 
)

Construct from internal field and dictionary.

Definition at line 33 of file distributionDiameterLagrangianScalarFieldSource.C.

Referenced by distributionDiameterLagrangianScalarFieldSource::clone().

Here is the caller graph for this function:

◆ distributionDiameterLagrangianScalarFieldSource() [2/2]

distributionDiameterLagrangianScalarFieldSource ( const distributionDiameterLagrangianScalarFieldSource &  field,
const regIOobject &  iIo 
)

Copy constructor setting the internal field reference.

Definition at line 56 of file distributionDiameterLagrangianScalarFieldSource.C.

◆ ~distributionDiameterLagrangianScalarFieldSource()

~distributionDiameterLagrangianScalarFieldSource ( )
virtual

Destructor.

Definition at line 72 of file distributionDiameterLagrangianScalarFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "distributionDiameter"  )

Runtime type information.

◆ clone()

virtual autoPtr<LagrangianScalarFieldSource> clone ( const regIOobject &  iIo) const
inlinevirtual

Construct and return a clone setting the internal field reference.

Definition at line 142 of file distributionDiameterLagrangianScalarFieldSource.H.

References distributionDiameterLagrangianScalarFieldSource::distributionDiameterLagrangianScalarFieldSource().

Here is the call graph for this function:

◆ value()

Foam::tmp< Foam::LagrangianSubScalarField > value ( const LagrangianInjection &  injection,
const LagrangianSubMesh &  subMesh 
) const
virtual

Return the value for an instantaneous injection.

Definition at line 80 of file distributionDiameterLagrangianScalarFieldSource.C.

References LagrangianModel::name(), Foam::name(), distribution::New(), DimensionedField< Type, GeoMesh, PrimitiveField >::New(), uniformSizeNumberLagrangianScalarFieldSource::sampleQ(), LagrangianSubMesh::size(), and timeIndex.

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 120 of file distributionDiameterLagrangianScalarFieldSource.C.

References Foam::vtkWriteOps::write(), and Foam::writeEntry().

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