Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
DampingModel< CloudType > Class Template Referenceabstract
Lagrangian particle models » Submodels » MP-PIC » Damping

Base class for collisional damping models. More...

Inheritance diagram for DampingModel< CloudType >:
[legend]
Collaboration diagram for DampingModel< CloudType >:
[legend]

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

template<class CloudType>
class Foam::DampingModel< CloudType >

Base class for collisional damping models.

Source files

Definition at line 101 of file KinematicCloud.H.

Constructor & Destructor Documentation

◆ DampingModel() [1/3]

DampingModel ( CloudType &  owner)

Construct null from owner.

Definition at line 35 of file DampingModel.C.

◆ DampingModel() [2/3]

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

Construct from components.

Definition at line 44 of file DampingModel.C.

◆ DampingModel() [3/3]

DampingModel ( const DampingModel< CloudType > &  cm)

Construct copy.

Definition at line 62 of file DampingModel.C.

◆ ~DampingModel()

~DampingModel ( )
virtual

Destructor.

Definition at line 72 of file DampingModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "dampingModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
DampingModel< CloudType >  ,
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.

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

◆ New()

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

Selector.

Definition at line 81 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 >.

Member Data Documentation

◆ timeScaleModel_

autoPtr<TimeScaleModel> timeScaleModel_
protected

Time scale model.

Definition at line 72 of file DampingModel.H.

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