driftModel Class Referenceabstract

Base class for drift models. More...

Inheritance diagram for driftModel:
Collaboration diagram for driftModel:

Classes

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

Public Member Functions

 TypeName ("driftModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, driftModel, dictionary,(const populationBalanceModel &popBal, const dictionary &dict),(popBal, dict))
 
 driftModel (const populationBalanceModel &popBal, const dictionary &dict)
 
autoPtr< driftModel > clone () const
 
virtual ~driftModel ()
 Destructor. More...
 
const populationBalanceModel & popBal () const
 Return reference to the populationBalanceModel. More...
 
const dictionary & dict () const
 Return reference to model dictionary. More...
 
virtual void precompute ()
 Precompute diameter independent expressions. More...
 
virtual void addToDriftRate (volScalarField &driftRate, const label i)=0
 Add to driftRate. More...
 

Static Public Member Functions

static autoPtr< driftModel > New (const word &type, const populationBalanceModel &popBal, const dictionary &dict)
 

Protected Attributes

const populationBalanceModel & popBal_
 Reference to the populationBalanceModel. More...
 
const dictionary dict_
 Model dictionary. More...
 

Detailed Description

Base class for drift models.

Source files

Definition at line 50 of file driftModel.H.

Constructor & Destructor Documentation

◆ driftModel()

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

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

Here is the caller graph for this function:

◆ ~driftModel()

virtual ~driftModel ( )
inlinevirtual

Destructor.

Definition at line 132 of file driftModel.H.

Member Function Documentation

◆ TypeName()

TypeName ( "driftModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ clone()

autoPtr<driftModel> clone ( ) const
inline

Definition at line 114 of file driftModel.H.

References driftModel::New(), NotImplemented, and Foam::type().

Here is the call graph for this function:

◆ New()

static autoPtr<driftModel> New ( const word &  type,
const populationBalanceModel &  popBal,
const dictionary &  dict 
)
static

Referenced by driftModel::clone(), and driftModel::iNew::operator()().

Here is the caller graph for this function:

◆ popBal()

const populationBalanceModel& popBal ( ) const
inline

Return reference to the populationBalanceModel.

Definition at line 139 of file driftModel.H.

◆ dict()

const dictionary& dict ( ) const
inline

Return reference to model dictionary.

Definition at line 145 of file driftModel.H.

References driftModel::addToDriftRate(), driftModel::dict_, and driftModel::precompute().

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

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

◆ precompute()

virtual void precompute ( )
virtual

Precompute diameter independent expressions.

Reimplemented in phaseChange.

Referenced by driftModel::dict().

Here is the caller graph for this function:

◆ addToDriftRate()

virtual void addToDriftRate ( volScalarField &  driftRate,
const label  i 
)
pure virtual

Add to driftRate.

Implemented in phaseChange, constantDrift, and densityChangeDrift.

Referenced by driftModel::dict().

Here is the caller graph for this function:

Member Data Documentation

◆ popBal_

const populationBalanceModel& popBal_
protected

Reference to the populationBalanceModel.

Definition at line 57 of file driftModel.H.

◆ dict_

const dictionary dict_
protected

Model dictionary.

Definition at line 60 of file driftModel.H.

Referenced by driftModel::dict().


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