Public Member Functions | Protected Member Functions | Protected Attributes
SuppressionCollision< CloudType > Class Template Reference

Inter-cloud collision model, whereby the canReact flag can be used to inhibit devolatilisation and surface reactions. More...

Inheritance diagram for SuppressionCollision< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for SuppressionCollision< CloudType >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("suppressionCollision")
 Runtime type information. More...
 
 SuppressionCollision (const dictionary &dict, CloudType &owner)
 Construct from dictionary. More...
 
 SuppressionCollision (const SuppressionCollision< CloudType > &cm)
 Construct copy. More...
 
virtual autoPtr< StochasticCollisionModel< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~SuppressionCollision ()
 Destructor. More...
 
- Public Member Functions inherited from StochasticCollisionModel< CloudType >
 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 (const scalar dt)
 Update the model. More...
 

Protected Member Functions

virtual void collide (const scalar dt)
 Update the model. More...
 

Protected Attributes

const word suppressionCloud_
 Name of cloud used for suppression. More...
 
const label suppressedParcelType_
 Suppressed parcel type - optional. More...
 

Additional Inherited Members

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

Detailed Description

template<class CloudType>
class Foam::SuppressionCollision< CloudType >

Inter-cloud collision model, whereby the canReact flag can be used to inhibit devolatilisation and surface reactions.

Definition at line 46 of file SuppressionCollision.H.

Constructor & Destructor Documentation

◆ SuppressionCollision() [1/2]

SuppressionCollision ( const dictionary dict,
CloudType owner 
)

Construct from dictionary.

Definition at line 63 of file SuppressionCollision.C.

◆ SuppressionCollision() [2/2]

Construct copy.

Definition at line 79 of file SuppressionCollision.C.

◆ ~SuppressionCollision()

Destructor.

Definition at line 92 of file SuppressionCollision.C.

Member Function Documentation

◆ collide()

void collide ( const scalar  dt)
protectedvirtual

Update the model.

Implements StochasticCollisionModel< CloudType >.

Definition at line 32 of file SuppressionCollision.C.

References Foam::dimTime, Foam::exp(), forAllIter, Foam::max(), p, Foam::type(), and kinematicCloud::vDotSweep().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "suppressionCollision"  )

Runtime type information.

◆ clone()

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

Construct and return a clone.

Definition at line 82 of file SuppressionCollision.H.

Field Documentation

◆ suppressionCloud_

const word suppressionCloud_
protected

Name of cloud used for suppression.

Definition at line 55 of file SuppressionCollision.H.

◆ suppressedParcelType_

const label suppressedParcelType_
protected

Suppressed parcel type - optional.

Definition at line 58 of file SuppressionCollision.H.


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