spherical Class Reference

Base class for models which represent spherical diameter models, providing a common implementation of surface area per unit volume. More...

Inheritance diagram for spherical:
Collaboration diagram for spherical:

Public Member Functions

 TypeName ("spherical")
 Runtime type information. More...
 
 spherical (const dictionary &diameterProperties, const phaseModel &phase)
 
virtual ~spherical ()
 Destructor. 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)
 
virtual ~diameterModel ()
 Destructor. More...
 
const dictionarydiameterProperties () const
 Return the phase diameter properties dictionary. More...
 
const phaseModelphase () const
 Return the phase. More...
 
tmp< volScalarFieldd () const
 Return the diameter. More...
 
tmp< volScalarFielda () 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...
 

Protected Member Functions

virtual tmp< volScalarFieldcalcA () const
 Get the diameter field. More...
 
- Protected Member Functions inherited from diameterModel
volScalarFielddRef ()
 Get a reference to the stored diameter field. More...
 
volScalarFieldaRef ()
 Get a reference to the stored surface area per unit volume field. More...
 
virtual tmp< volScalarFieldcalcD () const =0
 Get the diameter field. More...
 

Additional Inherited Members

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

Detailed Description

Base class for models which represent spherical diameter models, providing a common implementation of surface area per unit volume.

Source files

Definition at line 51 of file sphericalDiameter.H.

Constructor & Destructor Documentation

◆ spherical()

spherical ( const dictionary diameterProperties,
const phaseModel phase 
)

◆ ~spherical()

virtual ~spherical ( )
virtual

Destructor.

Member Function Documentation

◆ calcA()

virtual tmp<volScalarField> calcA ( ) const
protectedvirtual

Get the diameter field.

Implements diameterModel.

◆ TypeName()

TypeName ( "spherical"  )

Runtime type information.


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