StochasticCollisionModel Class Reference

Templated stochastic collision model class. More...

Inheritance diagram for StochasticCollisionModel:

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 (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 (const scalar dt)=0
	Main collision routine. More...

Detailed Description

Templated stochastic collision model class.

Source files

• StochasticCollisionModel.H
• StochasticCollisionModel.C
• StochasticCollisionModelNew.C

Definition at line 88 of file KinematicCloud.H.

Constructor & Destructor Documentation

StochasticCollisionModel() [1/3]

StochasticCollisionModel

(

CloudType &

owner

)

Construct null from owner.

Definition at line 32 of file StochasticCollisionModel.C.

StochasticCollisionModel() [2/3]

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

Construct from dictionary.

Definition at line 52 of file StochasticCollisionModel.C.

StochasticCollisionModel() [3/3]

StochasticCollisionModel

(

const StochasticCollisionModel< CloudType > &

cm

)

Construct copy.

Definition at line 42 of file StochasticCollisionModel.C.

~StochasticCollisionModel()

~StochasticCollisionModel ( )

virtual

Destructor.

Definition at line 65 of file StochasticCollisionModel.C.

Member Function Documentation

collide()

virtual void collide ( const scalar  dt )

protectedpure virtual

Main collision routine.

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

TypeName()

TypeName

(

"collisionModel"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		StochasticCollisionModel	,
		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.

New()

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

static

Selector.

Definition at line 33 of file StochasticCollisionModelNew.C.

update()

void update

(

const scalar

dt

)

Update the model.

Definition at line 72 of file StochasticCollisionModel.C.

---

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

• src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.H
• src/lagrangian/intermediate/submodels/Kinematic/StochasticCollision/StochasticCollisionModel/StochasticCollisionModel.H
• src/lagrangian/intermediate/submodels/Kinematic/StochasticCollision/StochasticCollisionModel/StochasticCollisionModel.C
• src/lagrangian/intermediate/submodels/Kinematic/StochasticCollision/StochasticCollisionModel/StochasticCollisionModelNew.C