Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
uniformSizeNumberLagrangianScalarFieldSource Class Reference

Base class for Lagrangian source conditions that calculate the number field from a total (e.g., mass, volume or flowRate) and a uniform size of the created parcels (e.g., mass, volume, surface area or number). More...

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

Public Types

enum class  uniformSize { number , surfaceArea , volume , mass }
 Enumeration for the uniform size. More...
 

Public Member Functions

 TypeName ("uniformSizeNumber")
 Runtime type information. More...
 
 uniformSizeNumberLagrangianScalarFieldSource (const regIOobject &, const dictionary &dict)
 Construct from internal field and dictionary. More...
 
 uniformSizeNumberLagrangianScalarFieldSource (const uniformSizeNumberLagrangianScalarFieldSource &, 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 ~uniformSizeNumberLagrangianScalarFieldSource ()
 Destructor. More...
 
label sampleQ () const
 Return the sample size exponent. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Static Public Attributes

static const NamedEnum< uniformSize, 4 > uniformSizeNames_
 Names of the uniform size. More...
 

Protected Member Functions

void calcSizes (const LagrangianInjection &injection, const LagrangianSubMesh &subMesh, tmp< LagrangianSubScalarField > &size, const bool needv, tmp< LagrangianSubScalarField > &v, const bool needm, tmp< LagrangianSubScalarField > &m) const
 Calculate the necessary sizes. More...
 

Detailed Description

Base class for Lagrangian source conditions that calculate the number field from a total (e.g., mass, volume or flowRate) and a uniform size of the created parcels (e.g., mass, volume, surface area or number).

Source files

Definition at line 52 of file uniformSizeNumberLagrangianScalarFieldSource.H.

Member Enumeration Documentation

◆ uniformSize

enum uniformSize
strong

Enumeration for the uniform size.

Enumerator
number 
surfaceArea 
volume 
mass 

Definition at line 62 of file uniformSizeNumberLagrangianScalarFieldSource.H.

Constructor & Destructor Documentation

◆ uniformSizeNumberLagrangianScalarFieldSource() [1/2]

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

Construct from internal field and dictionary.

Definition at line 117 of file uniformSizeNumberLagrangianScalarFieldSource.C.

Referenced by uniformSizeNumberLagrangianScalarFieldSource::clone().

Here is the caller graph for this function:

◆ uniformSizeNumberLagrangianScalarFieldSource() [2/2]

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

Copy constructor setting the internal field reference.

Definition at line 130 of file uniformSizeNumberLagrangianScalarFieldSource.C.

◆ ~uniformSizeNumberLagrangianScalarFieldSource()

~uniformSizeNumberLagrangianScalarFieldSource ( )
virtual

Destructor.

Definition at line 145 of file uniformSizeNumberLagrangianScalarFieldSource.C.

Member Function Documentation

◆ calcSizes()

void calcSizes ( const LagrangianInjection &  injection,
const LagrangianSubMesh &  subMesh,
tmp< LagrangianSubScalarField > &  size,
const bool  needv,
tmp< LagrangianSubScalarField > &  v,
const bool  needm,
tmp< LagrangianSubScalarField > &  m 
) const
protected

Calculate the necessary sizes.

Definition at line 52 of file uniformSizeNumberLagrangianScalarFieldSource.C.

References shaped::a, Foam::dimless, massive::m, uniformSizeNumberLagrangianScalarFieldSource::mass, DimensionedField< Type, GeoMesh, PrimitiveField >::New(), uniformSizeNumberLagrangianScalarFieldSource::number, uniformSizeNumberLagrangianScalarFieldSource::surfaceArea, shaped::v, and uniformSizeNumberLagrangianScalarFieldSource::volume.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "uniformSizeNumber"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting the internal field reference.

Reimplemented in totalNumberLagrangianScalarFieldSource, and flowRateNumberLagrangianScalarFieldSource.

Definition at line 122 of file uniformSizeNumberLagrangianScalarFieldSource.H.

References uniformSizeNumberLagrangianScalarFieldSource::uniformSizeNumberLagrangianScalarFieldSource().

Here is the call graph for this function:

◆ sampleQ()

Foam::label sampleQ ( ) const

Return the sample size exponent.

Definition at line 152 of file uniformSizeNumberLagrangianScalarFieldSource.C.

References Foam::labelMax.

Referenced by distributionDiameterLagrangianScalarFieldSource::value().

Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Reimplemented in totalNumberLagrangianScalarFieldSource, and flowRateNumberLagrangianScalarFieldSource.

Definition at line 170 of file uniformSizeNumberLagrangianScalarFieldSource.C.

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

Referenced by flowRateNumberLagrangianScalarFieldSource::write(), and totalNumberLagrangianScalarFieldSource::write().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ uniformSizeNames_

const Foam::NamedEnum< Foam::uniformSizeNumberLagrangianScalarFieldSource::uniformSize, 4 > uniformSizeNames_
static
Initial value:
{
"number",
"surfaceArea",
"volume",
"mass"
}

Names of the uniform size.

Definition at line 71 of file uniformSizeNumberLagrangianScalarFieldSource.H.

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