diameterModel Class Referenceabstract

Abstract base-class for dispersed-phase particle diameter models. More...

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

Public Member Functions

 TypeName ("diameterModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, diameterModel, dictionary,(const dictionary &dict, const phaseModel &phase),(dict, phase))
 
 diameterModel (const dictionary &dict, const phaseModel &phase)
 
virtual ~diameterModel ()=default
 Destructor. More...
 
const dictionarydiameterProperties () const
 Return the phase diameter properties dictionary. More...
 
const phaseModelphase () const
 Return the phase. More...
 
virtual tmp< volScalarFieldd () const =0
 Return the phase mean diameter field. More...
 
virtual void correct ()
 Correct the diameter field. More...
 
virtual bool read (const dictionary &phaseProperties)=0
 Read phaseProperties dictionary. More...
 
 TypeName ("diameterModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, diameterModel, dictionary,(const dictionary &dict, const phaseModel &phase),(dict, phase))
 
 diameterModel (const dictionary &dict, const phaseModel &phase)
 
virtual ~diameterModel ()=default
 Destructor. More...
 
const dictionarydiameterProperties () const
 Return the phase diameter properties dictionary. More...
 
const phaseModelphase () const
 Return the phase. More...
 
virtual tmp< volScalarFieldd () const =0
 Return the phase mean diameter field. More...
 
virtual void correct ()
 Correct the diameter field. More...
 
virtual bool read (const dictionary &dict)=0
 Read phaseProperties dictionary. More...
 

Static Public Member Functions

static autoPtr< diameterModelNew (const dictionary &diameterProperties, const phaseModel &phase)
 
static autoPtr< diameterModelNew (const dictionary &dict, const phaseModel &phase)
 

Protected Attributes

dictionary diameterProperties_
 
const phaseModelphase_
 

Detailed Description

Abstract base-class for dispersed-phase particle diameter models.

Source files

Source files

Definition at line 53 of file diameterModel.H.

Constructor & Destructor Documentation

◆ diameterModel() [1/2]

diameterModel ( const dictionary dict,
const phaseModel phase 
)

Definition at line 42 of file diameterModel.C.

◆ ~diameterModel() [1/2]

virtual ~diameterModel ( )
virtualdefault

Destructor.

◆ diameterModel() [2/2]

diameterModel ( const dictionary dict,
const phaseModel phase 
)

◆ ~diameterModel() [2/2]

virtual ~diameterModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName() [1/2]

TypeName ( "diameterModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable ( autoPtr  ,
diameterModel  ,
dictionary  ,
(const dictionary &dict, const phaseModel &phase ,
(dict, phase  
)

◆ New() [1/2]

Foam::autoPtr< Foam::diameterModel > New ( const dictionary diameterProperties,
const phaseModel phase 
)
static

Definition at line 56 of file diameterModel.C.

References Foam::abort(), dict, Foam::endl(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), Foam::Info, phase::name(), and dictionary::optionalSubDict().

Here is the call graph for this function:

◆ diameterProperties() [1/2]

const dictionary & diameterProperties ( ) const
inline

Return the phase diameter properties dictionary.

Definition at line 110 of file diameterModel.H.

References diameterModel::diameterProperties_.

◆ phase() [1/2]

const phaseModel & phase ( ) const
inline

Return the phase.

Definition at line 116 of file diameterModel.H.

References diameterModel::phase_.

Referenced by phaseChange::addToDriftRate(), phaseChange::correct(), IATEsource::fluid(), IATEsource::phase(), randomCoalescence::R(), turbulentBreakUp::R(), dummy::R(), velocityGroup::velocityGroup(), and sizeDistribution::write().

Here is the caller graph for this function:

◆ d() [1/2]

virtual tmp< volScalarField > d ( ) const
pure virtual

Return the phase mean diameter field.

Implemented in constant, isothermal, linearTsub, velocityGroup, IATE, constant, IATE, and isothermal.

◆ correct() [1/2]

void correct ( )
virtual

Correct the diameter field.

Reimplemented in isothermal, linearTsub, IATE, and IATE.

Definition at line 92 of file diameterModel.C.

◆ read() [1/2]

bool read ( const dictionary phaseProperties)
pure virtual

Read phaseProperties dictionary.

Implemented in constant, velocityGroup, constant, isothermal, linearTsub, IATE, IATE, and isothermal.

Definition at line 96 of file diameterModel.C.

References dict, dictionary::optionalSubDict(), and Foam::type().

Here is the call graph for this function:

◆ TypeName() [2/2]

TypeName ( "diameterModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable ( autoPtr  ,
diameterModel  ,
dictionary  ,
(const dictionary &dict, const phaseModel &phase ,
(dict, phase  
)

◆ New() [2/2]

static autoPtr< diameterModel > New ( const dictionary dict,
const phaseModel phase 
)
static

◆ diameterProperties() [2/2]

const dictionary & diameterProperties ( ) const
inline

Return the phase diameter properties dictionary.

Definition at line 109 of file diameterModel.H.

References diameterModel::diameterProperties_.

◆ phase() [2/2]

const phaseModel & phase ( ) const
inline

Return the phase.

Definition at line 115 of file diameterModel.H.

References diameterModel::phase_.

◆ d() [2/2]

virtual tmp< volScalarField > d ( ) const
pure virtual

Return the phase mean diameter field.

Implemented in constant, isothermal, linearTsub, velocityGroup, IATE, constant, IATE, and isothermal.

◆ correct() [2/2]

virtual void correct ( )
virtual

Correct the diameter field.

Reimplemented in isothermal, linearTsub, IATE, and IATE.

◆ read() [2/2]

virtual bool read ( const dictionary dict)
pure virtual

Member Data Documentation

◆ diameterProperties_

dictionary diameterProperties_
protected

Definition at line 59 of file diameterModel.H.

Referenced by diameterModel::diameterProperties().

◆ phase_

const phaseModel & phase_
protected

Definition at line 61 of file diameterModel.H.

Referenced by IATE::a(), diameterModel::phase(), and velocityGroup::velocityGroup().


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