Public Member Functions | List of all members
nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource 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 nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource:
Inheritance graph
[legend]
Collaboration diagram for nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("nucleationGroupSurfaceAreaVolumeRatio")
 Runtime type information. More...
 
 nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource (const DimensionedField< scalar, fvMesh > &, const dictionary &dict)
 Construct from internal field and dictionary. More...
 
 nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource (const nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource &, 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 ~nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource ()
 Destructor. More...
 
virtual tmp< DimensionedField< scalar, fvMesh > > sourceValue (const fvSource &model, const DimensionedField< scalar, fvMesh > &source) 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...
 
- 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

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            nucleationGroupSurfaceAreaVolumeRatio;
    libs            ("libmultiphaseEulerFvModels.so");
}
Source files

Definition at line 62 of file nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource.H.

Constructor & Destructor Documentation

◆ nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource() [1/2]

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

Construct from internal field and dictionary.

Definition at line 33 of file nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource.C.

◆ nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource() [2/2]

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

Copy constructor setting internal field reference.

Definition at line 45 of file nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource.C.

◆ ~nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource()

~nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource ( )
virtual

Destructor.

Definition at line 59 of file nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "nucleationGroupSurfaceAreaVolumeRatio"  )

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 90 of file nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource.H.

◆ sourceValue()

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 67 of file nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource.C.

References Foam::constant::electromagnetic::kappa, fvModel::name(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ internalCoeff()

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 83 of file nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource.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: