nucleationModel Class Referenceabstract

Base class for nucleation models. More...

Inheritance diagram for nucleationModel:
Collaboration diagram for nucleationModel:

Classes

class  iNew
 Class used for the read-construction of. More...
 

Public Member Functions

 TypeName ("nucleationModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, nucleationModel, dictionary,(const populationBalanceModel &popBal, const dictionary &dict),(popBal, dict))
 
 nucleationModel (const populationBalanceModel &popBal, const dictionary &dict)
 
autoPtr< nucleationModelclone () const
 
virtual ~nucleationModel ()
 Destructor. More...
 
const populationBalanceModelpopBal () const
 Return reference to the populationBalanceModel. More...
 
const dictionarydict () const
 Return reference to model dictionary. More...
 
virtual void precompute ()
 Precompute diameter independent expressions. More...
 
virtual void addToNucleationRate (volScalarField &nucleationRate, const label i)=0
 Add to nucleationRate. More...
 

Static Public Member Functions

static autoPtr< nucleationModelNew (const word &type, const populationBalanceModel &popBal, const dictionary &dict)
 

Protected Attributes

const populationBalanceModelpopBal_
 Reference to the populationBalanceModel. More...
 
const dictionary dict_
 Model dictionary. More...
 
const velocityGroupvelGroup_
 Velocity group in which the nucleation occurs. More...
 

Detailed Description

Base class for nucleation models.

See also
Foam::diameterModels::populationBalanceModel
Source files

Definition at line 53 of file nucleationModel.H.

Constructor & Destructor Documentation

◆ nucleationModel()

nucleationModel ( const populationBalanceModel popBal,
const dictionary dict 
)

Definition at line 72 of file nucleationModel.C.

◆ ~nucleationModel()

virtual ~nucleationModel ( )
inlinevirtual

Destructor.

Definition at line 138 of file nucleationModel.H.

Member Function Documentation

◆ TypeName()

TypeName ( "nucleationModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
nucleationModel  ,
dictionary  ,
(const populationBalanceModel &popBal, const dictionary &dict ,
(popBal, dict  
)

◆ clone()

autoPtr<nucleationModel> clone ( ) const
inline

Definition at line 120 of file nucleationModel.H.

References NotImplemented.

◆ New()

Foam::autoPtr< Foam::diameterModels::nucleationModel > New ( const word type,
const populationBalanceModel popBal,
const dictionary dict 
)
static

Definition at line 43 of file nucleationModel.C.

References nucleationModel::dict(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, IOobject::name(), Foam::nl, nucleationModel::popBal(), and Foam::type().

Referenced by nucleationModel::iNew::operator()().

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

◆ popBal()

const populationBalanceModel& popBal ( ) const
inline

Return reference to the populationBalanceModel.

Definition at line 145 of file nucleationModel.H.

References nucleationModel::popBal_.

Referenced by nucleationModel::New().

Here is the caller graph for this function:

◆ dict()

const dictionary& dict ( ) const
inline

Return reference to model dictionary.

Definition at line 151 of file nucleationModel.H.

References nucleationModel::dict_.

Referenced by nucleationModel::New(), nucleationModel::iNew::operator()(), and reactionDriven::reactionDriven().

Here is the caller graph for this function:

◆ precompute()

void precompute ( )
virtual

Precompute diameter independent expressions.

Reimplemented in wallBoiling.

Definition at line 92 of file nucleationModel.C.

◆ addToNucleationRate()

virtual void addToNucleationRate ( volScalarField nucleationRate,
const label  i 
)
pure virtual

Add to nucleationRate.

Implemented in wallBoiling, and reactionDriven.

Member Data Documentation

◆ popBal_

const populationBalanceModel& popBal_
protected

Reference to the populationBalanceModel.

Definition at line 60 of file nucleationModel.H.

Referenced by nucleationModel::popBal().

◆ dict_

const dictionary dict_
protected

Model dictionary.

Definition at line 63 of file nucleationModel.H.

Referenced by nucleationModel::dict().

◆ velGroup_

const velocityGroup& velGroup_
protected

Velocity group in which the nucleation occurs.

Definition at line 66 of file nucleationModel.H.

Referenced by reactionDriven::reactionDriven().


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