nucleationSurfaceAreaVolumeRatioFvScalarFieldSource Class Reference

This source condition creates a nucleation source term in the surface-area-to-volume-ratio (kappa) equations of the fractal shape model of population balance. The fvSource it relates to should be a nucleation model. More...

Inheritance diagram for nucleationSurfaceAreaVolumeRatioFvScalarFieldSource:
Collaboration diagram for nucleationSurfaceAreaVolumeRatioFvScalarFieldSource:

Public Member Functions

 TypeName ("nucleationSurfaceAreaVolumeRatio")
 Runtime type information. More...
 
 nucleationSurfaceAreaVolumeRatioFvScalarFieldSource (const DimensionedField< scalar, volMesh > &, const dictionary &dict)
 Construct from internal field and dictionary. More...
 
 nucleationSurfaceAreaVolumeRatioFvScalarFieldSource (const nucleationSurfaceAreaVolumeRatioFvScalarFieldSource &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual autoPtr< fvScalarFieldSource > clone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual ~nucleationSurfaceAreaVolumeRatioFvScalarFieldSource ()
 Destructor. More...
 
virtual tmp< DimensionedField< scalar, volMesh > > sourceValue (const fvSource &model, const DimensionedField< scalar, volMesh > &source) const
 Return the source value. More...
 
virtual tmp< DimensionedField< scalar, volMesh > > internalCoeff (const fvSource &model, const DimensionedField< scalar, volMesh > &source) const
 Return the internal coefficient. More...
 
- Public Member Functions inherited from secondaryPropertyFvScalarFieldSource
 secondaryPropertyFvScalarFieldSource (const DimensionedField< scalar, volMesh > &)
 Construct from internal field. More...
 
const UPtrList< diameterModels::sizeGroup > & fis () const
 Return the list of size-groups. More...
 
label i () const
 Return the index of this group. More...
 
const diameterModels::sizeGroupfi (const label deltai=0) const
 Return a size-group. More...
 
template<class ModelType >
const volScalarFieldfld (const label deltai=0) const
 Return a secondary property field. More...
 
template<class ModelType >
const ModelType & model (const label deltai=0) const
 Return a secondary property model. More...
 
template<class ModelType >
const Foam::volScalarFieldfld (const label deltai) const
 

Detailed Description

This source condition creates a nucleation source term in the surface-area-to-volume-ratio (kappa) equations of the fractal shape model of population balance. The fvSource it relates to should be a nucleation model.

Usage
Example of the source condition specification:
<sourceName>
{
    type            nucleationSurfaceAreaVolumeRatio;
    libs            ("libmultiphaseEulerFvModels.so");
}
Source files

Definition at line 62 of file nucleationSurfaceAreaVolumeRatioFvScalarFieldSource.H.

Constructor & Destructor Documentation

◆ nucleationSurfaceAreaVolumeRatioFvScalarFieldSource() [1/2]

Construct from internal field and dictionary.

Definition at line 35 of file nucleationSurfaceAreaVolumeRatioFvScalarFieldSource.C.

◆ nucleationSurfaceAreaVolumeRatioFvScalarFieldSource() [2/2]

Copy constructor setting internal field reference.

Definition at line 47 of file nucleationSurfaceAreaVolumeRatioFvScalarFieldSource.C.

◆ ~nucleationSurfaceAreaVolumeRatioFvScalarFieldSource()

Member Function Documentation

◆ TypeName()

TypeName ( "nucleationSurfaceAreaVolumeRatio"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Definition at line 90 of file nucleationSurfaceAreaVolumeRatioFvScalarFieldSource.H.

◆ sourceValue()

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

Return the source value.

Definition at line 69 of file nucleationSurfaceAreaVolumeRatioFvScalarFieldSource.C.

References fvModel::name().

Here is the call graph for this function:

◆ internalCoeff()

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

Return the internal coefficient.

Definition at line 84 of file nucleationSurfaceAreaVolumeRatioFvScalarFieldSource.C.

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

Here is the call graph for this function:

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