Inter-cloud collision model, whereby the canReact flag can be used to inhibit devolatilisation and surface reactions. More...

Inheritance diagram for SuppressionCollision< CloudType >:

[legend]

Collaboration diagram for SuppressionCollision< CloudType >:

[legend]

Public Member Functions
	TypeName ("suppressionCollision")
	Runtime type information. More...

	SuppressionCollision (const dictionary &dict, CloudType &owner)
	Construct from dictionary. More...

	SuppressionCollision (const SuppressionCollision< CloudType > &cm)
	Construct copy. More...

virtual autoPtr< StochasticCollisionModel< CloudType > >	clone () const
	Construct and return a clone. More...

virtual	~SuppressionCollision ()
	Destructor. More...

Public Member Functions inherited from StochasticCollisionModel< CloudType >
	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	~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...

Protected Member Functions
virtual void	collide (const scalar dt)
	Update the model. More...

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

Protected Attributes
const word	suppressionCloud_
	Name of cloud used for suppression. More...

const label	suppressedParcelType_
	Suppressed parcel type - optional. 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...

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

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

Detailed Description

template<class CloudType>
class Foam::SuppressionCollision< CloudType >

Inter-cloud collision model, whereby the canReact flag can be used to inhibit devolatilisation and surface reactions.

Definition at line 46 of file SuppressionCollision.H.

Constructor & Destructor Documentation

◆ SuppressionCollision() [1/2]

SuppressionCollision	(	const dictionary &	dict,
		CloudType &	owner
	)

Construct from dictionary.

Definition at line 63 of file SuppressionCollision.C.

Referenced by SuppressionCollision< CloudType >::collide().

Here is the caller graph for this function:

◆ SuppressionCollision() [2/2]

SuppressionCollision ( const SuppressionCollision< CloudType > & cm )

Construct copy.

Definition at line 79 of file SuppressionCollision.C.

◆ ~SuppressionCollision()

~SuppressionCollision ( )

virtual

Destructor.

Definition at line 92 of file SuppressionCollision.C.

Referenced by SuppressionCollision< CloudType >::clone().

Here is the caller graph for this function:

Member Function Documentation

◆ collide()

void collide ( const scalar dt )

protectedvirtual

Update the model.

Implements StochasticCollisionModel< CloudType >.

Definition at line 32 of file SuppressionCollision.C.

References Foam::dimTime, Foam::exp(), forAllIter, Foam::max(), p, SuppressionCollision< CloudType >::SuppressionCollision(), and kinematicCloud::vDotSweep().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "suppressionCollision" )

Runtime type information.

◆ clone()

virtual autoPtr<StochasticCollisionModel<CloudType> > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements StochasticCollisionModel< CloudType >.

Definition at line 82 of file SuppressionCollision.H.

References SuppressionCollision< CloudType >::~SuppressionCollision().

Here is the call graph for this function:

Member Data Documentation

◆ suppressionCloud_

const word suppressionCloud_

protected

Name of cloud used for suppression.

Definition at line 55 of file SuppressionCollision.H.

◆ suppressedParcelType_

const label suppressedParcelType_

protected

Suppressed parcel type - optional.

Definition at line 58 of file SuppressionCollision.H.

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

src/lagrangian/intermediate/submodels/ReactingMultiphase/StochasticCollision/SuppressionCollision/SuppressionCollision.H
src/lagrangian/intermediate/submodels/ReactingMultiphase/StochasticCollision/SuppressionCollision/SuppressionCollision.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members