BinaryCollisionModel< CloudType > Class Template Reference

Templated DSMC particle collision class. More...

#include <BinaryCollisionModel.H>

Inheritance diagram for BinaryCollisionModel< CloudType >:

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

Static Public Member Functions
static autoPtr< BinaryCollisionModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector.

Detailed Description

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

Templated DSMC particle collision class.

Source files

• BinaryCollisionModel.H
• BinaryCollisionModel.C
• BinaryCollisionModelNew.C

Definition at line 50 of file BinaryCollisionModel.H.

Constructor & Destructor Documentation

BinaryCollisionModel() [1/2]

template<class CloudType>

BinaryCollisionModel

(

CloudType &

owner

)

Construct null from owner.

Definition at line 26 of file BinaryCollisionModel.C.

References owner().

Referenced by declareRunTimeSelectionTable(), LarsenBorgnakkeVariableHardSphere< CloudType >::LarsenBorgnakkeVariableHardSphere(), NoBinaryCollision< CloudType >::NoBinaryCollision(), and VariableHardSphere< CloudType >::VariableHardSphere().

Here is the call graph for this function:

Here is the caller graph for this function:

BinaryCollisionModel() [2/2]

template<class CloudType>

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

Construct from components.

Definition at line 35 of file BinaryCollisionModel.C.

References dict(), and owner().

Here is the call graph for this function:

~BinaryCollisionModel()

template<class CloudType>

~BinaryCollisionModel ( )

virtual

Destructor.

Definition at line 51 of file BinaryCollisionModel.C.

Member Function Documentation

TypeName()

template<class CloudType>

TypeName

(

"BinaryCollisionModel< CloudType >"

)

Runtime type information.

declareRunTimeSelectionTable()

template<class CloudType>

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

Declare runtime constructor selection table.

References BinaryCollisionModel(), dict(), and owner().

Here is the call graph for this function:

New()

template<class CloudType>

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

static

Selector.

Definition at line 28 of file BinaryCollisionModelNew.C.

References dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and owner().

Here is the call graph for this function:

owner() [1/2]

template<class CloudType>

const CloudType & owner

(

)

const

Return the owner cloud object.

Definition at line 59 of file BinaryCollisionModel.C.

Referenced by BinaryCollisionModel(), BinaryCollisionModel(), LarsenBorgnakkeVariableHardSphere< CloudType >::collide(), VariableHardSphere< CloudType >::collide(), declareRunTimeSelectionTable(), New(), LarsenBorgnakkeVariableHardSphere< CloudType >::sigmaTcR(), and VariableHardSphere< CloudType >::sigmaTcR().

Here is the caller graph for this function:

owner() [2/2]

template<class CloudType>

CloudType & owner

(

)

Return non-const access to the owner cloud object.

Definition at line 67 of file BinaryCollisionModel.C.

dict()

template<class CloudType>

const Foam::dictionary & dict

(

)

const

Return the dictionary.

Definition at line 75 of file BinaryCollisionModel.C.

Referenced by BinaryCollisionModel(), declareRunTimeSelectionTable(), LarsenBorgnakkeVariableHardSphere< CloudType >::LarsenBorgnakkeVariableHardSphere(), New(), NoBinaryCollision< CloudType >::NoBinaryCollision(), LarsenBorgnakkeVariableHardSphere< CloudType >::TypeName(), NoBinaryCollision< CloudType >::TypeName(), VariableHardSphere< CloudType >::TypeName(), and VariableHardSphere< CloudType >::VariableHardSphere().

Here is the caller graph for this function:

coeffDict()

template<class CloudType>

const Foam::dictionary & coeffDict

(

)

const

Return the coefficients dictionary.

Definition at line 83 of file BinaryCollisionModel.C.

Referenced by LarsenBorgnakkeVariableHardSphere< CloudType >::LarsenBorgnakkeVariableHardSphere(), and VariableHardSphere< CloudType >::VariableHardSphere().

Here is the caller graph for this function:

active()

template<class CloudType>

virtual bool active ( ) const

pure virtual

Flag to indicate whether model activates collision model.

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

sigmaTcR()

template<class 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 >, NoBinaryCollision< CloudType >, and VariableHardSphere< CloudType >.

collide()

template<class CloudType>

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

pure virtual

Apply collision.

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

---

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

• src/lagrangian/DSMC/clouds/Templates/DSMCCloud/DSMCCloud.H
• src/lagrangian/DSMC/submodels/BinaryCollisionModel/BinaryCollisionModel/BinaryCollisionModel.H
• src/lagrangian/DSMC/submodels/BinaryCollisionModel/BinaryCollisionModel/BinaryCollisionModel.C
• src/lagrangian/DSMC/submodels/BinaryCollisionModel/BinaryCollisionModel/BinaryCollisionModelNew.C