BinaryCollisionModel< CloudType > Class Template Referenceabstract

Templated DSMC particle collision class. More...

Inheritance diagram for BinaryCollisionModel< CloudType >:

Public Member Functions

 TypeName ("BinaryCollisionModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, BinaryCollisionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table. More...
 
 BinaryCollisionModel (CloudType &owner)
 Construct null from owner. More...
 
 BinaryCollisionModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from components. More...
 
virtual ~BinaryCollisionModel ()
 Destructor. More...
 
const CloudTypeowner () const
 Return the owner cloud object. More...
 
CloudTypeowner ()
 Return non-const access to the owner cloud object. More...
 
const dictionarydict () const
 Return the dictionary. More...
 
const dictionarycoeffDict () const
 Return the coefficients dictionary. More...
 
virtual bool active () const =0
 Flag to indicate whether model activates collision model. More...
 
virtual scalar sigmaTcR (const typename CloudType::parcelType &pP, const typename CloudType::parcelType &pQ) const =0
 Return the collision cross section * relative velocity product. More...
 
virtual void collide (typename CloudType::parcelType &pP, typename CloudType::parcelType &pQ)=0
 Apply collision. More...
 

Static Public Member Functions

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

Detailed Description

template<class CloudType>
class Foam::BinaryCollisionModel< CloudType >

Templated DSMC particle collision class.

Source files

Definition at line 55 of file DSMCCloud.H.

Constructor & Destructor Documentation

Construct null from owner.

Definition at line 31 of file BinaryCollisionModel.C.

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

Construct from components.

Definition at line 41 of file BinaryCollisionModel.C.

~BinaryCollisionModel ( )
virtual

Destructor.

Definition at line 56 of file BinaryCollisionModel.C.

Member Function Documentation

TypeName ( "BinaryCollisionModel< CloudType >"  )

Runtime type information.

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

Declare runtime constructor selection table.

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

Selector.

Definition at line 33 of file BinaryCollisionModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), and Foam::nl.

Here is the call graph for this function:

const CloudType & owner ( ) const

Return the owner cloud object.

Definition at line 64 of file BinaryCollisionModel.C.

CloudType & owner ( )

Return non-const access to the owner cloud object.

Definition at line 72 of file BinaryCollisionModel.C.

const Foam::dictionary & dict ( ) const

Return the dictionary.

Definition at line 80 of file BinaryCollisionModel.C.

const Foam::dictionary & coeffDict ( ) const

Return the coefficients dictionary.

Definition at line 88 of file BinaryCollisionModel.C.

virtual bool active ( ) const
pure virtual

Flag to indicate whether model activates collision model.

Implemented in LarsenBorgnakkeVariableHardSphere< CloudType >, VariableHardSphere< CloudType >, and NoBinaryCollision< CloudType >.

virtual scalar sigmaTcR ( const typename CloudType::parcelType pP,
const typename CloudType::parcelType pQ 
) const
pure virtual

Return the collision cross section * relative velocity product.

Implemented in LarsenBorgnakkeVariableHardSphere< CloudType >, VariableHardSphere< CloudType >, and NoBinaryCollision< CloudType >.

virtual void collide ( typename CloudType::parcelType pP,
typename CloudType::parcelType pQ 
)
pure virtual

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