CollisionModel< CloudType > Class Template Referenceabstract

Templated collision model class. More...

Inheritance diagram for CollisionModel< CloudType >:
[legend]

Public Member Functions

 TypeName ("collisionModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, CollisionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table. More...
 
 CollisionModel (CloudType &owner)
 Construct null from owner. More...
 
 CollisionModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from components. More...
 
 CollisionModel (const CollisionModel< CloudType > &cm)
 Construct copy. More...
 
virtual autoPtr< CollisionModel< CloudType > > clone () const =0
 Construct and return a clone. More...
 
virtual ~CollisionModel ()
 Destructor. More...
 
virtual label nSubCycles () const =0
 Return the number of times to subcycle the current. More...
 
virtual void collide ()=0
 

Static Public Member Functions

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

Detailed Description

template<class CloudType>
class Foam::CollisionModel< CloudType >

Templated collision model class.

Source files

Definition at line 58 of file CollidingCloud.H.

Constructor & Destructor Documentation

◆ CollisionModel() [1/3]

CollisionModel ( CloudType owner)

Construct null from owner.

Definition at line 33 of file CollisionModel.C.

◆ CollisionModel() [2/3]

CollisionModel ( const dictionary dict,
CloudType owner,
const word type 
)

Construct from components.

Definition at line 41 of file CollisionModel.C.

◆ CollisionModel() [3/3]

Construct copy.

Definition at line 53 of file CollisionModel.C.

◆ ~CollisionModel()

~CollisionModel ( )
virtual

Destructor.

Definition at line 64 of file CollisionModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "collisionModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

◆ clone()

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

Construct and return a clone.

Implemented in PairCollision< CloudType >, and NoCollision< CloudType >.

◆ New()

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

Selector.

Definition at line 36 of file CollisionModelNew.C.

◆ nSubCycles()

virtual label nSubCycles ( ) const
pure virtual

Return the number of times to subcycle the current.

timestep to meet the criteria of the collision model

Implemented in PairCollision< CloudType >, and NoCollision< CloudType >.

◆ collide()

virtual void collide ( )
pure virtual

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