Public Member Functions | List of all members
distributionLagrangianScalarFieldSource Class Reference

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

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

Public Member Functions

 TypeName ("distribution")
 Runtime type information. More...
 
 distributionLagrangianScalarFieldSource (const regIOobject &, const dictionary &dict)
 Construct from internal field and dictionary. More...
 
 distributionLagrangianScalarFieldSource (const distributionLagrangianScalarFieldSource &, 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 ~distributionLagrangianScalarFieldSource ()
 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 a property randomly sampled from a given distribution.

Usage
Property Description Required? Default
distribution The distribution yes

Example specification: 

    <LagrangianModelName>
    {
        type            distribution;
        distribution
        {
            type            normal;
            Q               0;
            min             200 [kg/m^3];
            max             1800 [kg/m^3];
            mu              1000 [kg/m^3];
            sigma           400 [];
        }
    }
See also
Foam::distributions
Source files

Definition at line 86 of file distributionLagrangianScalarFieldSource.H.

Constructor & Destructor Documentation

◆ distributionLagrangianScalarFieldSource() [1/2]

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

Construct from internal field and dictionary.

Definition at line 31 of file distributionLagrangianScalarFieldSource.C.

Referenced by distributionLagrangianScalarFieldSource::clone().

Here is the caller graph for this function:

◆ distributionLagrangianScalarFieldSource() [2/2]

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

Copy constructor setting the internal field reference.

Definition at line 53 of file distributionLagrangianScalarFieldSource.C.

◆ ~distributionLagrangianScalarFieldSource()

~distributionLagrangianScalarFieldSource ( )
virtual

Destructor.

Definition at line 68 of file distributionLagrangianScalarFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "distribution"  )

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 124 of file distributionLagrangianScalarFieldSource.H.

References distributionLagrangianScalarFieldSource::distributionLagrangianScalarFieldSource().

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 76 of file distributionLagrangianScalarFieldSource.C.

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

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 100 of file distributionLagrangianScalarFieldSource.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: