nucleationModel Class Reference

Base class for nucleation models. More...

#include <nucleationModel.H>

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.
	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.
const populationBalanceModel &	popBal () const
	Return reference to the populationBalanceModel.
virtual void	correct ()
	Correct diameter independent expressions.
virtual void	addToNucleationRate (volScalarField &nucleationRate, const label i)=0
	Add to nucleationRate.

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.

Detailed Description

Base class for nucleation models.

Source files

• nucleationModel.H
• nucleationModel.C

Definition at line 48 of file nucleationModel.H.

Constructor & Destructor Documentation

nucleationModel()

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

Definition at line 66 of file nucleationModel.C.

References dict, popBal(), and popBal_.

Referenced by constantNucleation::constantNucleation(), declareRunTimeSelectionTable(), and wallBoiling::wallBoiling().

Here is the call graph for this function:

Here is the caller graph for this function:

~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)	)

References dict, nucleationModel(), and popBal().

Here is the call graph for this function:

clone()

autoPtr< nucleationModel > clone ( ) const

inline

Definition at line 116 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 40 of file nucleationModel.C.

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

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 144 of file nucleationModel.H.

References popBal_.

Referenced by constantNucleation::constantNucleation(), declareRunTimeSelectionTable(), nucleationModel::iNew::iNew(), New(), nucleationModel(), constantNucleation::TypeName(), wallBoiling::TypeName(), and wallBoiling::wallBoiling().

Here is the caller graph for this function:

correct()

void correct ( )

virtual

Correct diameter independent expressions.

Reimplemented in constantNucleation, and wallBoiling.

Definition at line 78 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 57 of file nucleationModel.H.

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

---

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

• src/phaseSystemModels/reactingEuler/multiphaseSystem/populationBalanceModel/nucleationModels/nucleationModel/nucleationModel.H
• src/phaseSystemModels/reactingEuler/multiphaseSystem/populationBalanceModel/nucleationModels/nucleationModel/nucleationModel.C