nucleationModel Class Referenceabstract

Base class for nucleation models. More...

Inheritance diagram for nucleationModel:
Collaboration diagram for nucleationModel:


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 ()=default
 Destructor. More...
const populationBalanceModelpopBal () const
 Return reference to the populationBalanceModel. More...
virtual void correct ()
 Correct 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...

Detailed Description

Base class for nucleation models.

Source files

Definition at line 52 of file nucleationModel.H.

Constructor & Destructor Documentation

◆ nucleationModel()

nucleationModel ( const populationBalanceModel popBal,
const dictionary dict 

Definition at line 74 of file nucleationModel.C.

◆ ~nucleationModel()

virtual ~nucleationModel ( )


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

Definition at line 113 of file nucleationModel.H.

References NotImplemented.

◆ New()

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

Definition at line 48 of file nucleationModel.C.

References dict, Foam::exit(), Foam::FatalIOError, and FatalIOErrorInLookup.

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

Return reference to the populationBalanceModel.

Definition at line 137 of file nucleationModel.H.

References nucleationModel::popBal_.

◆ correct()

void correct ( )

Correct diameter independent expressions.

Reimplemented in wallBoiling, and constantNucleation.

Definition at line 85 of file nucleationModel.C.

◆ addToNucleationRate()

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

Add to nucleationRate.

Implemented in wallBoiling, and constantNucleation.

Member Data Documentation

◆ popBal_

const populationBalanceModel& popBal_

Reference to the populationBalanceModel.

Definition at line 59 of file nucleationModel.H.

Referenced by wallBoiling::correct(), and nucleationModel::popBal().

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