CollisionModel Class Reference

Templated collision model class. More...

Inheritance diagram for CollisionModel:

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 bool	controlsWallInteraction () const =0
	Indicates whether model determines wall collisions or not,. More...
virtual void	collide ()=0

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

Private Types
typedef CloudType::parcelType	parcelType
	Convenience typedef for parcel type. More...

Detailed Description

Templated collision model class.

Source files

• CollisionModel.H
• CollisionModel.C
• CollisionModelNew.C

Definition at line 53 of file CollidingCloud.H.

Member Typedef Documentation

parcelType

typedef CloudType::parcelType parcelType

private

Convenience typedef for parcel type.

Definition at line 60 of file CollisionModel.H.

Constructor & Destructor Documentation

CollisionModel() [1/3]

CollisionModel

(

CloudType &

owner

)

Construct null from owner.

Definition at line 31 of file CollisionModel.C.

CollisionModel() [2/3]

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

Construct from components.

Definition at line 39 of file CollisionModel.C.

CollisionModel() [3/3]

CollisionModel

(

const CollisionModel< CloudType > &

cm

)

Construct copy.

Definition at line 51 of file CollisionModel.C.

~CollisionModel()

~CollisionModel ( )

virtual

Destructor.

Definition at line 62 of file CollisionModel.C.

Member Function Documentation

TypeName()

TypeName

(

"collisionModel"

)

Runtime type information.

declareRunTimeSelectionTable()

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

New()

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

static

Selector.

Definition at line 33 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

controlsWallInteraction()

virtual bool controlsWallInteraction ( ) const

pure virtual

Indicates whether model determines wall collisions or not,.

used to determine what value to use for wallImpactDistance

collide()

virtual void collide ( )

pure virtual

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

---

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

• src/lagrangian/intermediate/clouds/Templates/CollidingCloud/CollidingCloud.H
• src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/CollisionModel/CollisionModel.H
• src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/CollisionModel/CollisionModel.C
• src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/CollisionModel/CollisionModelNew.C