Public Member Functions | List of all members
distributionGroupFractionFvScalarFieldSource Class Reference

Source condition for group fractions of a population balance model that sets values corresponding to a given distribution. More...

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

Public Member Functions

 TypeName ("distributionGroupFraction")
 Runtime type information. More...
 
 distributionGroupFractionFvScalarFieldSource (const DimensionedField< scalar, fvMesh > &, const dictionary &dict)
 Construct from internal field and dictionary. More...
 
 distributionGroupFractionFvScalarFieldSource (const distributionGroupFractionFvScalarFieldSource &, const DimensionedField< scalar, fvMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual autoPtr< fvScalarFieldSource > clone (const DimensionedField< scalar, fvMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual ~distributionGroupFractionFvScalarFieldSource ()
 Destructor. More...
 
virtual tmp< DimensionedField< scalar, fvMesh > > sourceValue (const fvSource &model, const DimensionedField< scalar, fvMesh > &source) const
 Return the source value. More...
 
virtual tmp< scalarField > sourceValue (const fvSource &model, const scalarField &source, const labelUList &cells) const
 Return the source value. More...
 
virtual tmp< DimensionedField< scalar, fvMesh > > internalCoeff (const fvSource &model, const DimensionedField< scalar, fvMesh > &source) const
 Return the internal coefficient. More...
 
virtual tmp< scalarField > internalCoeff (const fvSource &model, const scalarField &source, const labelUList &cells) const
 Return the internal coefficient. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from groupPropertyFvScalarField
 groupPropertyFvScalarField (const DimensionedField< scalar, fvMesh > &)
 Construct from internal field. More...
 
const populationBalanceModel & popBal () const
 Return the population balance. More...
 
label i () const
 Return the index of this group. More...
 

Detailed Description

Source condition for group fractions of a population balance model that sets values corresponding to a given distribution.

Usage
Example of the source condition specification: 
<sourceName>
{
    type        distributionGroupFraction;
    distribution
    {
        type        RosinRammler;
        Q           0;
        min         1 [mm];
        max         15 [mm];
        d           14 [mm];
        n           2 [];
    }
}
Source files

Definition at line 69 of file distributionGroupFractionFvScalarFieldSource.H.

Constructor & Destructor Documentation

◆ distributionGroupFractionFvScalarFieldSource() [1/2]

distributionGroupFractionFvScalarFieldSource ( const DimensionedField< scalar, fvMesh > &  iF,
const dictionary &  dict 
)

Construct from internal field and dictionary.

Definition at line 60 of file distributionGroupFractionFvScalarFieldSource.C.

◆ distributionGroupFractionFvScalarFieldSource() [2/2]

distributionGroupFractionFvScalarFieldSource ( const distributionGroupFractionFvScalarFieldSource &  field,
const DimensionedField< scalar, fvMesh > &  iF 
)

Copy constructor setting internal field reference.

Definition at line 77 of file distributionGroupFractionFvScalarFieldSource.C.

◆ ~distributionGroupFractionFvScalarFieldSource()

~distributionGroupFractionFvScalarFieldSource ( )
virtual

Destructor.

Definition at line 93 of file distributionGroupFractionFvScalarFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "distributionGroupFraction"  )

Runtime type information.

◆ clone()

virtual autoPtr<fvScalarFieldSource> clone ( const DimensionedField< scalar, fvMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 114 of file distributionGroupFractionFvScalarFieldSource.H.

◆ sourceValue() [1/2]

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::fvMesh > > sourceValue ( const fvSource &  model,
const DimensionedField< scalar, fvMesh > &  source 
) const
virtual

Return the source value.

Definition at line 101 of file distributionGroupFractionFvScalarFieldSource.C.

References Foam::dimless, fvModel::name(), and DimensionedField< Type, GeoMesh, PrimitiveField >::New().

Here is the call graph for this function:

◆ sourceValue() [2/2]

Foam::tmp< Foam::scalarField > sourceValue ( const fvSource &  model,
const scalarField &  source,
const labelUList &  cells 
) const
virtual

Return the source value.

Definition at line 118 of file distributionGroupFractionFvScalarFieldSource.C.

References List< T >::size().

Here is the call graph for this function:

◆ internalCoeff() [1/2]

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::fvMesh > > internalCoeff ( const fvSource &  model,
const DimensionedField< scalar, fvMesh > &  source 
) const
virtual

Return the internal coefficient.

Definition at line 130 of file distributionGroupFractionFvScalarFieldSource.C.

References Foam::dimless, fvModel::name(), and DimensionedField< Type, GeoMesh, PrimitiveField >::New().

Here is the call graph for this function:

◆ internalCoeff() [2/2]

Foam::tmp< Foam::scalarField > internalCoeff ( const fvSource &  model,
const scalarField &  source,
const labelUList &  cells 
) const
virtual

Return the internal coefficient.

Definition at line 147 of file distributionGroupFractionFvScalarFieldSource.C.

References List< T >::size().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 158 of file distributionGroupFractionFvScalarFieldSource.C.

References Foam::dimLength, 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: