residualDiameter Class Reference

A diameter model which switches form constant diameter to constant residual diameter when the volume fraction of the phase is below residualAlpha. More...

Inheritance diagram for residualDiameter:
Collaboration diagram for residualDiameter:

Public Member Functions

 TypeName ("residualDiameter")
 Runtime type information. More...
 
 residualDiameter (const dictionary &diameterProperties, const phaseModel &phase)
 
virtual ~residualDiameter ()
 Destructor. More...
 
virtual tmp< volScalarFieldd () const
 Get the diameter field. More...
 
virtual bool read (const dictionary &diameterProperties)
 Read diameterProperties dictionary. More...
 
- Public Member Functions inherited from spherical
 TypeName ("spherical")
 Runtime type information. More...
 
 spherical (const dictionary &diameterProperties, const phaseModel &phase)
 Construct from dictionary and phase. More...
 
virtual ~spherical ()
 Destructor. More...
 
virtual tmp< volScalarFieldAv () const
 Get the surface area per unit volume field. More...
 
- Public Member Functions inherited from diameterModel
 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)
 Construct from dictionary and phase. More...
 
virtual ~diameterModel ()
 Destructor. More...
 
const dictionarydiameterProperties () const
 Return the phase diameter properties dictionary. More...
 
const phaseModelphase () const
 Return the phase. More...
 
virtual void correct ()
 Correct the model. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from diameterModel
static autoPtr< diameterModelNew (const dictionary &diameterProperties, const phaseModel &phase)
 Select from dictionary and phase. More...
 

Detailed Description

A diameter model which switches form constant diameter to constant residual diameter when the volume fraction of the phase is below residualAlpha.

A typical use case for this is to set a small residual diameter to prevent excessive phase velocities in regions where the phase volume fraction is small.

Source files

Definition at line 55 of file residualDiameter.H.

Constructor & Destructor Documentation

◆ residualDiameter()

residualDiameter ( const dictionary diameterProperties,
const phaseModel phase 
)

Definition at line 49 of file residualDiameter.C.

◆ ~residualDiameter()

~residualDiameter ( )
virtual

Destructor.

Definition at line 63 of file residualDiameter.C.

Member Function Documentation

◆ TypeName()

TypeName ( "residualDiameter"  )

Runtime type information.

◆ d()

Foam::tmp< Foam::volScalarField > d ( ) const
virtual

Get the diameter field.

Implements diameterModel.

Definition at line 69 of file residualDiameter.C.

References Foam::neg(), and Foam::pos0().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary diameterProperties)
virtual

Read diameterProperties dictionary.

Reimplemented from diameterModel.

Definition at line 78 of file residualDiameter.C.

References diameterModel::read().

Here is the call graph for this function:

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