Templated stochastic collision model class. More...

Inheritance diagram for StochasticCollisionModel< CloudType >:

[legend]

Collaboration diagram for StochasticCollisionModel< CloudType >:

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...

Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud. More...

	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name. More...

	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name. More...

	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Construct as copy. More...

virtual	~CloudSubModelBase ()
	Destructor. More...

const CloudType &	owner () const
	Return const access to the owner cloud. More...

virtual bool	writeTime () const
	Flag to indicate when to write a property. More...

CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation. More...

virtual void	write (Ostream &os) const
	Write. More...

Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null. More...

	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name. More...

	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name. More...

	subModelBase (const subModelBase &smb)
	Construct as copy. More...

virtual	~subModelBase ()
	Destructor. More...

const word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () const
	Return const access to the properties dictionary. More...

virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg. More...

virtual bool	active () const
	Return the model 'active' status - default active = true. More...

virtual void	cacheFields (const bool store)
	Cache dependant sub-model fields. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property from the base model. More...

template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model. More...

template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model. More...

template<class Type >
void	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model. More...

template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property from the sub-model. More...

template<class Type >
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-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...

Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line. More...

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for. More...

Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud. More...

Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	Reference to properties dictionary e.g. for restart. More...

const dictionary	dict_
	Copy of dictionary used during construction. More...

const word	baseName_
	Name of the sub-model base class. More...

const word	modelType_
	Type of the sub-model. More...

const dictionary	coeffDict_
	Coefficients dictionary. More...

Detailed Description

template<class CloudType>
class Foam::StochasticCollisionModel< CloudType >

Templated stochastic collision model class.

Source files

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.

Referenced by StochasticCollisionModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::StochasticCollisionModel().

Here is the caller graph for this function:

◆ 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< CloudType >	,
		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.

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

◆ 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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members