TimeScaleModel Class Reference

Base class for time scale models. More...

#include <TimeScaleModel.H>

Inheritance diagram for TimeScaleModel:

Public Member Functions
	TypeName ("timeScaleModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, TimeScaleModel, dictionary,(const dictionary &dict),(dict))
	Declare runtime constructor selection table.
	TimeScaleModel (const dictionary &dict)
	Constructors.
	TimeScaleModel (const TimeScaleModel &sm)
	Construct a copy.
virtual autoPtr< TimeScaleModel >	clone () const =0
	Construct and return a clone.
virtual	~TimeScaleModel ()
	Destructor.
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.

Static Public Member Functions
static autoPtr< TimeScaleModel >	New (const dictionary &dict)
	Selector.

Protected Attributes
scalar	alphaPacked_
	Close pack volume fraction.
scalar	e_
	Coefficient of restitution.

Detailed Description

Base class for time scale models.

Source files

• TimeScaleModel.H
• TimeScaleModel.C

Definition at line 53 of file TimeScaleModel.H.

Constructor & Destructor Documentation

TimeScaleModel() [1/2]

TimeScaleModel

(

const dictionary &

dict

)

Constructors.

Construct from components

Definition at line 35 of file TimeScaleModel.C.

References alphaPacked_, dict, and e_.

Referenced by declareRunTimeSelectionTable(), equilibrium::equilibrium(), equilibrium::equilibrium(), isotropic::isotropic(), isotropic::isotropic(), nonEquilibrium::nonEquilibrium(), nonEquilibrium::nonEquilibrium(), and TimeScaleModel().

Here is the caller graph for this function:

TimeScaleModel() [2/2]

TimeScaleModel

(

const TimeScaleModel &

sm

)

Construct a copy.

Definition at line 46 of file TimeScaleModel.C.

References alphaPacked_, e_, and TimeScaleModel().

Here is the call graph for this function:

~TimeScaleModel()

~TimeScaleModel ( )

virtual

Destructor.

Definition at line 87 of file TimeScaleModel.C.

Member Function Documentation

TypeName()

TypeName

(

"timeScaleModel"

)

Runtime type information.

declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

References dict, and TimeScaleModel().

Here is the call graph for this function:

clone()

virtual autoPtr< TimeScaleModel > clone ( ) const

pure virtual

Construct and return a clone.

Implemented in equilibrium, isotropic, and nonEquilibrium.

References dict.

New()

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

static

Selector.

Definition at line 59 of file TimeScaleModel.C.

References Foam::abort(), dict, Foam::endl(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::Info.

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 equilibrium, isotropic, and nonEquilibrium.

References alpha, and f().

Here is the call graph for this function:

Member Data Documentation

alphaPacked_

scalar alphaPacked_

protected

Close pack volume fraction.

Definition at line 74 of file TimeScaleModel.H.

Referenced by equilibrium::oneByTau(), isotropic::oneByTau(), nonEquilibrium::oneByTau(), TimeScaleModel(), and TimeScaleModel().

e_

scalar e_

protected

Coefficient of restitution.

Definition at line 79 of file TimeScaleModel.H.

Referenced by equilibrium::oneByTau(), isotropic::oneByTau(), nonEquilibrium::oneByTau(), TimeScaleModel(), and TimeScaleModel().

---

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

• src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/TimeScaleModel/TimeScaleModel.H
• src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/TimeScaleModel/TimeScaleModel.C