Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
diameterModel Class Referenceabstract

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

Inheritance diagram for diameterModel:
Inheritance graph
[legend]

Public Member Functions

 TypeName ("diameterModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, diameterModel, dictionary,(const dictionary &diameterProperties, const phaseModel &phase),(diameterProperties, phase))
 
 diameterModel (const dictionary &diameterProperties, const phaseModel &phase)
 
virtual ~diameterModel ()
 Destructor. More...
 
const dictionary & diameterProperties () const
 Return the phase diameter properties dictionary. More...
 
const phaseModel & phase () const
 Return the phase. More...
 
tmp< volScalarField > d () const
 Return the diameter. More...
 
tmp< volScalarField > a () const
 Return the surface area per unit volume. More...
 
virtual void correct ()
 Correct the diameter field. More...
 
virtual bool read (const dictionary &phaseProperties)
 Read phaseProperties dictionary. More...
 

Static Public Member Functions

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

Protected Member Functions

volScalarField & dRef ()
 Get a reference to the stored diameter field. More...
 
volScalarField & aRef ()
 Get a reference to the stored surface area per unit volume field. More...
 
virtual tmp< volScalarField > calcD () const =0
 Get the diameter field. More...
 
virtual tmp< volScalarField > calcA () const =0
 Get the surface area per unit volume field. More...
 

Detailed Description

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

Source files

Definition at line 51 of file diameterModel.H.

Constructor & Destructor Documentation

◆ diameterModel()

diameterModel ( const dictionary &  diameterProperties,
const phaseModel &  phase 
)

◆ ~diameterModel()

virtual ~diameterModel ( )
virtual

Destructor.

Member Function Documentation

◆ dRef()

volScalarField& dRef ( )
protected

Get a reference to the stored diameter field.

◆ aRef()

volScalarField& aRef ( )
protected

Get a reference to the stored surface area per unit volume field.

◆ calcD()

virtual tmp<volScalarField> calcD ( ) const
protectedpure virtual

Get the diameter field.

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

◆ calcA()

virtual tmp<volScalarField> calcA ( ) const
protectedpure virtual

Get the surface area per unit volume field.

Implemented in velocityGroup, IATE, and spherical.

◆ TypeName()

TypeName ( "diameterModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

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

◆ diameterProperties()

const dictionary& diameterProperties ( ) const
inline

Return the phase diameter properties dictionary.

Definition at line 131 of file diameterModel.H.

◆ phase()

const phaseModel& phase ( ) const
inline

Return the phase.

Definition at line 137 of file diameterModel.H.

References diameterModel::a(), diameterModel::correct(), diameterModel::d(), and diameterModel::read().

Referenced by IATEsource::fluid(), and IATEsource::phase().

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

◆ d()

tmp<volScalarField> d ( ) const

Return the diameter.

Referenced by diameterModel::phase().

Here is the caller graph for this function:

◆ a()

tmp<volScalarField> a ( ) const

Return the surface area per unit volume.

Referenced by diameterModel::phase().

Here is the caller graph for this function:

◆ correct()

virtual void correct ( )
virtual

Correct the diameter field.

Reimplemented in IATE, linearTsub, and isothermal.

Referenced by diameterModel::phase().

Here is the caller graph for this function:

◆ read()

virtual bool read ( const dictionary &  phaseProperties)
virtual

Read phaseProperties dictionary.

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

Referenced by diameterModel::phase().

Here is the caller graph for this function:
The documentation for this class was generated from the following file: