Dummy collision model for 'none'. More...

#include <NoStochasticCollision.H>

Inheritance diagram for NoStochasticCollision< CloudType >:

Collaboration diagram for NoStochasticCollision< CloudType >:

Public Member Functions
	TypeName ("none")
	Runtime type information.
	NoStochasticCollision (const dictionary &dict, CloudType &owner)
	Construct from dictionary.
	NoStochasticCollision (const NoStochasticCollision< CloudType > &cm)
	Construct copy.
virtual autoPtr< StochasticCollisionModel< CloudType > >	clone () const
	Construct and return a clone.
virtual	~NoStochasticCollision ()
	Destructor.
virtual bool	active () const
	Flag to indicate whether model activates collision model.
Public Member Functions inherited from StochasticCollisionModel< CloudType >
	TypeName ("collisionModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, StochasticCollisionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table.
	StochasticCollisionModel (CloudType &owner)
	Construct null from owner.
	StochasticCollisionModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from dictionary.
	StochasticCollisionModel (const StochasticCollisionModel< CloudType > &cm)
	Construct copy.
virtual	~StochasticCollisionModel ()
	Destructor.
void	update (typename CloudType::parcelType::trackingData &td, const scalar dt)
	Update the model.
Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud.
	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name.
	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name.
	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Construct as copy.
virtual	~CloudSubModelBase ()=default
	Destructor.
const CloudType &	owner () const
	Return const access to the owner cloud.
virtual bool	writeTime () const
	Flag to indicate when to write a property.
virtual fileName	localPath () const
	Output directory.
CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation.
virtual void	info ()
	Write to info.
virtual void	write (Ostream &os) const
	Write to os.
Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null.
	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name.
	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name.
	subModelBase (const subModelBase &smb)
	Construct as copy.
virtual	~subModelBase ()=default
	Destructor.
const word &	modelName () const
	Return const access to the name of the sub-model.
const dictionary &	dict () const
	Return const access to the cloud dictionary.
const word &	baseName () const
	Return const access to the base name of the sub-model.
const word &	modelType () const
	Return const access to the sub-model type.
const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary.
const dictionary &	properties () const
	Return const access to the properties dictionary.
virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg.
virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields.
template<class Type>
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the base model.
template<class Type>
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model.
template<class Type>
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model.
bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set.
template<class Type>
bool	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model.
template<class Type>
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the sub-model.
template<class Type>
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model.

Protected Member Functions
virtual void	collide (typename CloudType::parcelType::trackingData &td, const scalar dt)
	Update the model.
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line.

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for.
Static Public Member Functions inherited from StochasticCollisionModel< CloudType >
static autoPtr< StochasticCollisionModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector.
Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info.
Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud.
Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model.
dictionary &	properties_
	Reference to properties dictionary e.g. for restart.
const dictionary	dict_
	Copy of dictionary used during construction.
const word	baseName_
	Name of the sub-model base class.
const word	modelType_
	Type of the sub-model.
const dictionary	coeffDict_
	Coefficients dictionary.

Detailed Description

template<class CloudType>
class Foam::NoStochasticCollision< CloudType >

Dummy collision model for 'none'.

Definition at line 44 of file NoStochasticCollision.H.

Constructor & Destructor Documentation

◆ NoStochasticCollision() [1/2]

template<class CloudType>

NoStochasticCollision	(	const dictionary &	dict,
		CloudType &	owner )

Construct from dictionary.

Definition at line 37 of file NoStochasticCollision.C.

References subModelBase::dict(), CloudSubModelBase< CloudType >::owner(), and StochasticCollisionModel< CloudType >::StochasticCollisionModel().

Referenced by clone(), NoStochasticCollision(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NoStochasticCollision() [2/2]

template<class CloudType>

NoStochasticCollision ( const NoStochasticCollision< CloudType > & cm )

Construct copy.

Definition at line 48 of file NoStochasticCollision.C.

References NoStochasticCollision(), and StochasticCollisionModel< CloudType >::StochasticCollisionModel().

Here is the call graph for this function:

◆ ~NoStochasticCollision()

template<class CloudType>

~NoStochasticCollision ( )

virtual

Destructor.

Definition at line 60 of file NoStochasticCollision.C.

Member Function Documentation

◆ collide()

template<class CloudType>

void collide	(	typename CloudType::parcelType::trackingData &	td,
		const scalar	dt )

protectedvirtual

Update the model.

Implements StochasticCollisionModel< CloudType >.

Definition at line 26 of file NoStochasticCollision.C.

◆ TypeName()

template<class CloudType>

TypeName ( "none" )

Runtime type information.

References subModelBase::dict(), NoStochasticCollision(), and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

◆ clone()

template<class CloudType>

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

inlinevirtual

Construct and return a clone.

Implements StochasticCollisionModel< CloudType >.

Definition at line 85 of file NoStochasticCollision.H.

References NoStochasticCollision().

Here is the call graph for this function:

◆ active()

template<class CloudType>

bool active ( ) const

virtual

Flag to indicate whether model activates collision model.

Reimplemented from subModelBase.

Definition at line 67 of file NoStochasticCollision.C.

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

src/lagrangian/intermediate/submodels/Kinematic/StochasticCollision/NoStochasticCollision/NoStochasticCollision.H
src/lagrangian/intermediate/submodels/Kinematic/StochasticCollision/NoStochasticCollision/NoStochasticCollision.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NoStochasticCollision() [1/2]

◆ NoStochasticCollision() [2/2]

◆ ~NoStochasticCollision()

Member Function Documentation

◆ collide()

◆ TypeName()

◆ clone()

◆ active()