TimeScaleModel Class Referenceabstract

Base class for time scale models. More...

Inheritance diagram for TimeScaleModel:

Public Member Functions

 TypeName ("timeScaleModel")
 Runtime type information. More...
 declareRunTimeSelectionTable (autoPtr, TimeScaleModel, dictionary,(const dictionary &dict),(dict))
 Declare runtime constructor selection table. More...
 TimeScaleModel (const dictionary &dict)
 Constructors. More...
 TimeScaleModel (const TimeScaleModel &sm)
 Construct a copy. More...
virtual autoPtr< TimeScaleModelclone () const =0
 Construct and return a clone. More...
virtual ~TimeScaleModel ()
 Destructor. More...
virtual tmp< FieldField< Field, scalar > > oneByTau (const FieldField< Field, scalar > &alpha, const FieldField< Field, scalar > &r32, const FieldField< Field, scalar > &uSqr, const FieldField< Field, scalar > &f) const =0
 Member Functions. More...

Static Public Member Functions

static autoPtr< TimeScaleModelNew (const dictionary &dict)
 Selector. More...

Protected Attributes

scalar alphaPacked_
 Close pack volume fraction. More...
scalar e_
 Coefficient of restitution. More...

Detailed Description

Base class for time scale models.

Source files

Definition at line 52 of file TimeScaleModel.H.

Constructor & Destructor Documentation

◆ TimeScaleModel() [1/2]

TimeScaleModel ( const dictionary dict)


Construct from components

Definition at line 39 of file TimeScaleModel.C.

◆ TimeScaleModel() [2/2]

TimeScaleModel ( const TimeScaleModel sm)

Construct a copy.

Definition at line 50 of file TimeScaleModel.C.

◆ ~TimeScaleModel()

~TimeScaleModel ( )


Definition at line 91 of file TimeScaleModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "timeScaleModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
TimeScaleModel  ,
dictionary  ,
(const dictionary &dict ,

Declare runtime constructor selection table.

◆ clone()

virtual autoPtr<TimeScaleModel> clone ( ) const
pure virtual

Construct and return a clone.

Implemented in nonEquilibrium, isotropic, and equilibrium.

◆ New()

Foam::autoPtr< Foam::TimeScaleModel > New ( const dictionary dict)


Definition at line 63 of file TimeScaleModel.C.

References Foam::abort(), dict, Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), and Foam::nl.

Here is the call graph for this function:

◆ oneByTau()

virtual tmp<FieldField<Field, scalar> > oneByTau ( const FieldField< Field, scalar > &  alpha,
const FieldField< Field, scalar > &  r32,
const FieldField< Field, scalar > &  uSqr,
const FieldField< Field, scalar > &  f 
) const
pure virtual

Member Functions.

Time scale

Implemented in nonEquilibrium, isotropic, and equilibrium.

Member Data Documentation

◆ alphaPacked_

scalar alphaPacked_

Close pack volume fraction.

Definition at line 65 of file TimeScaleModel.H.

◆ e_

scalar e_

Coefficient of restitution.

Definition at line 68 of file TimeScaleModel.H.

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