DampingModel Class Reference

Base class for collisional damping models. More...

Inheritance diagram for DampingModel:

Collaboration diagram for DampingModel:

Public Member Functions
	TypeName ("dampingModel")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, DampingModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table. More...
	DampingModel (CloudType &owner)
	Construct null from owner. More...
	DampingModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from components. More...
	DampingModel (const DampingModel< CloudType > &cm)
	Construct copy. More...
virtual autoPtr< DampingModel< CloudType > >	clone () const =0
	Construct and return a clone. More...
virtual	~DampingModel ()
	Destructor. More...
virtual vector	velocityCorrection (typename CloudType::parcelType &p, const scalar deltaT) const =0
	Calculate the velocity correction. More...

Static Public Member Functions
static autoPtr< DampingModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector. More...

Protected Attributes
autoPtr< TimeScaleModel >	timeScaleModel_
	Time scale model. More...

Detailed Description

Base class for collisional damping models.

Source files

• DampingModel.H
• DampingModel.C
• DampingModelNew.C

Definition at line 56 of file MPPICCloud.H.

Constructor & Destructor Documentation

DampingModel() [1/3]

DampingModel

(

CloudType &

owner

)

Construct null from owner.

Definition at line 32 of file DampingModel.C.

DampingModel() [2/3]

DampingModel	(	const dictionary &	dict,
		CloudType &	owner,
		const word &	type
	)

Construct from components.

Definition at line 41 of file DampingModel.C.

DampingModel() [3/3]

DampingModel

(

const DampingModel< CloudType > &

cm

)

Construct copy.

Definition at line 59 of file DampingModel.C.

~DampingModel()

~DampingModel ( )

virtual

Destructor.

Definition at line 69 of file DampingModel.C.

Member Function Documentation

TypeName()

TypeName

(

"dampingModel"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		DampingModel	,
		dictionary	,
		(const dictionary &dict, CloudType &owner)	,
		(dict, owner)
	)

Declare runtime constructor selection table.

clone()

virtual autoPtr<DampingModel<CloudType> > clone ( ) const

pure virtual

Construct and return a clone.

New()

Foam::autoPtr< Foam::DampingModel< CloudType > > New ( const dictionary &  dict, CloudType &  owner  )

static

Selector.

Definition at line 78 of file DampingModel.C.

velocityCorrection()

virtual vector velocityCorrection ( typename CloudType::parcelType &  p, const scalar  deltaT  ) const

pure virtual

Calculate the velocity correction.

Implemented in Relaxation< CloudType >, and NoDamping< CloudType >.

Field Documentation

timeScaleModel_

autoPtr<TimeScaleModel> timeScaleModel_

protected

Time scale model.

Definition at line 66 of file DampingModel.H.

---

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

• src/lagrangian/intermediate/clouds/Templates/MPPICCloud/MPPICCloud.H
• src/lagrangian/intermediate/submodels/MPPIC/DampingModels/DampingModel/DampingModel.H
• src/lagrangian/intermediate/submodels/MPPIC/DampingModels/DampingModel/DampingModel.C