Classes | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
nucleationModel Class Referenceabstract

Base class for nucleation models. More...

Inheritance diagram for nucleationModel:
[legend]
Collaboration diagram for nucleationModel:
[legend]

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< nucleationModel > clone () const
 
virtual ~nucleationModel ()=default
 Destructor. More...
 
const populationBalanceModel & popBal () 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< nucleationModel > New (const word &type, const populationBalanceModel &popBal, const dictionary &dict)
 

Protected Attributes

const populationBalanceModel & popBal_
 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 73 of file nucleationModel.C.

◆ ~nucleationModel()

virtual ~nucleationModel ( )
virtualdefault

Destructor.

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 113 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 47 of file nucleationModel.C.

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

Here is the call graph for this function:

◆ popBal()

const populationBalanceModel & popBal ( ) const
inline

Return reference to the populationBalanceModel.

Definition at line 137 of file nucleationModel.H.

References nucleationModel::popBal_.

Referenced by nucleationModel::New().

Here is the caller graph for this function:

◆ correct()

void correct ( )
virtual

Correct diameter independent expressions.

Reimplemented in constantNucleation, and wallBoiling.

Definition at line 85 of file nucleationModel.C.

◆ addToNucleationRate()

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

Add to nucleationRate.

Implemented in constantNucleation, and wallBoiling.

Member Data Documentation

◆ popBal_

const populationBalanceModel& popBal_
protected

Reference to the populationBalanceModel.

Definition at line 59 of file nucleationModel.H.

Referenced by nucleationModel::popBal().

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