Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
StochasticCollisionModel< CloudType > Class Template Referenceabstract
Lagrangian particle models » Submodels » Kinematic » Collision

Templated stochastic collision model class. More...

Inheritance diagram for StochasticCollisionModel< CloudType >:
[legend]

Public Member Functions

 TypeName ("collisionModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, StochasticCollisionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table. More...
 
 StochasticCollisionModel (CloudType &owner)
 Construct null from owner. More...
 
 StochasticCollisionModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from dictionary. More...
 
 StochasticCollisionModel (const StochasticCollisionModel< CloudType > &cm)
 Construct copy. More...
 
virtual autoPtr< StochasticCollisionModel< CloudType > > clone () const =0
 Construct and return a clone. More...
 
virtual ~StochasticCollisionModel ()
 Destructor. More...
 
void update (typename CloudType::parcelType::trackingData &td, const scalar dt)
 Update the model. More...
 

Static Public Member Functions

static autoPtr< StochasticCollisionModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 

Protected Member Functions

virtual void collide (typename CloudType::parcelType::trackingData &td, const scalar dt)=0
 Main collision routine. More...
 

Detailed Description

template<class CloudType>
class Foam::StochasticCollisionModel< CloudType >

Templated stochastic collision model class.

Source files

Definition at line 95 of file KinematicCloud.H.

Constructor & Destructor Documentation

◆ StochasticCollisionModel() [1/3]

StochasticCollisionModel ( CloudType &  owner)

Construct null from owner.

Definition at line 34 of file StochasticCollisionModel.C.

◆ StochasticCollisionModel() [2/3]

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

Construct from dictionary.

Definition at line 54 of file StochasticCollisionModel.C.

◆ StochasticCollisionModel() [3/3]

StochasticCollisionModel ( const StochasticCollisionModel< CloudType > &  cm)

Construct copy.

Definition at line 44 of file StochasticCollisionModel.C.

◆ ~StochasticCollisionModel()

~StochasticCollisionModel ( )
virtual

Destructor.

Definition at line 67 of file StochasticCollisionModel.C.

Member Function Documentation

◆ collide()

virtual void collide ( typename CloudType::parcelType::trackingData &  td,
const scalar  dt 
)
protectedpure virtual

Main collision routine.

Implemented in SuppressionCollision< CloudType >, ORourkeCollision< CloudType >, TrajectoryCollision< CloudType >, and NoStochasticCollision< CloudType >.

◆ TypeName()

TypeName ( "collisionModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
StochasticCollisionModel< CloudType >  ,
dictionary  ,
(const dictionary &dict, CloudType &owner)  ,
(dict, owner)   
)

Declare runtime constructor selection table.

◆ clone()

virtual autoPtr<StochasticCollisionModel<CloudType> > clone ( ) const
pure virtual

Construct and return a clone.

Implemented in ORourkeCollision< CloudType >, TrajectoryCollision< CloudType >, SuppressionCollision< CloudType >, and NoStochasticCollision< CloudType >.

◆ New()

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

Selector.

Definition at line 36 of file StochasticCollisionModelNew.C.

◆ update()

void update ( typename CloudType::parcelType::trackingData &  td,
const scalar  dt 
)

Update the model.

Definition at line 75 of file StochasticCollisionModel.C.

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