breakupModel Class Referenceabstract

Base class for breakup models which provide a total breakup rate and a separate daughter size distribution function. More...

Inheritance diagram for breakupModel:
Collaboration diagram for breakupModel:

Classes

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

Public Member Functions

 TypeName ("breakupModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, breakupModel, dictionary,(const populationBalanceModel &popBal, const dictionary &dict),(popBal, dict))
 
 breakupModel (const populationBalanceModel &popBal, const dictionary &dict)
 
autoPtr< breakupModelclone () const
 
virtual ~breakupModel ()
 Destructor. More...
 
const populationBalanceModelpopBal () const
 Return reference to the populationBalanceModel. More...
 
const autoPtr< daughterSizeDistributionModel > & dsdPtr () const
 Return const-reference to daughter size distribution pointer. More...
 
autoPtr< daughterSizeDistributionModel > & dsdPtr ()
 Return reference to daughter size distribution pointer. More...
 
virtual void precompute ()
 Precompute diameter independent expressions. More...
 
virtual void setBreakupRate (volScalarField &breakupRate, const label i)=0
 Set total breakupRate. More...
 

Static Public Member Functions

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

Protected Attributes

const populationBalanceModelpopBal_
 Reference to the populationBalanceModel. More...
 
dictionary dict_
 Dictionary. More...
 
autoPtr< daughterSizeDistributionModeldsd_
 Daughter size distribution model. More...
 

Detailed Description

Base class for breakup models which provide a total breakup rate and a separate daughter size distribution function.

See also
Foam::diameterModels::populationBalanceModel
Source files

Definition at line 55 of file breakupModel.H.

Constructor & Destructor Documentation

◆ breakupModel()

breakupModel ( const populationBalanceModel popBal,
const dictionary dict 
)

Definition at line 72 of file breakupModel.C.

References dict, breakupModel::dsd_, and daughterSizeDistributionModel::New().

Here is the call graph for this function:

◆ ~breakupModel()

virtual ~breakupModel ( )
inlinevirtual

Destructor.

Definition at line 140 of file breakupModel.H.

Member Function Documentation

◆ TypeName()

TypeName ( "breakupModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ clone()

autoPtr<breakupModel> clone ( ) const
inline

Definition at line 122 of file breakupModel.H.

References NotImplemented.

◆ New()

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

Definition at line 43 of file breakupModel.C.

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

Referenced by breakupModel::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 147 of file breakupModel.H.

References breakupModel::popBal_.

Referenced by daughterSizeDistributionModel::New(), and breakupModel::New().

Here is the caller graph for this function:

◆ dsdPtr() [1/2]

const autoPtr<daughterSizeDistributionModel>& dsdPtr ( ) const
inline

Return const-reference to daughter size distribution pointer.

Definition at line 153 of file breakupModel.H.

References breakupModel::dsd_.

◆ dsdPtr() [2/2]

Return reference to daughter size distribution pointer.

Definition at line 159 of file breakupModel.H.

References breakupModel::dsd_.

◆ precompute()

void precompute ( )
virtual

Precompute diameter independent expressions.

Definition at line 87 of file breakupModel.C.

◆ setBreakupRate()

virtual void setBreakupRate ( volScalarField breakupRate,
const label  i 
)
pure virtual

Set total breakupRate.

Implemented in powerLaw, Laakkonen, Kusters, and exponential.

Member Data Documentation

◆ popBal_

const populationBalanceModel& popBal_
protected

Reference to the populationBalanceModel.

Definition at line 62 of file breakupModel.H.

Referenced by breakupModel::popBal().

◆ dict_

dictionary dict_
protected

Dictionary.

Definition at line 65 of file breakupModel.H.

◆ dsd_

Daughter size distribution model.

Definition at line 68 of file breakupModel.H.

Referenced by breakupModel::breakupModel(), and breakupModel::dsdPtr().


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