Base class for collisional damping models. More...

Inheritance diagram for DampingModel< CloudType >:

[legend]

Collaboration diagram for DampingModel< CloudType >:

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

	declareRunTimeSelectionTable (autoPtr, DampingModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table. More...

	DampingModel (CloudType &owner)
	Construct null from owner. More...

	DampingModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from components. More...

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

virtual autoPtr< DampingModel< CloudType > >	clone () const =0
	Construct and return a clone. More...

virtual	~DampingModel ()
	Destructor. More...

virtual vector	velocityCorrection (typename CloudType::parcelType &p, const scalar deltaT) const =0
	Calculate the velocity correction. 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)
	Copy constructor. 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)
	Copy constructor. 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 void	cacheFields (const bool store)
	Cache dependent 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...

void	operator= (const subModelBase &)=delete
	Disallow default bitwise assignment. More...

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

Protected Attributes
autoPtr< TimeScaleModel >	timeScaleModel_
	Time scale model. 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...

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

Detailed Description

template<class CloudType>
class Foam::DampingModel< CloudType >

Base class for collisional damping models.

Source files

Definition at line 56 of file MPPICCloud.H.

Constructor & Destructor Documentation

◆ DampingModel() [1/3]

DampingModel ( CloudType & owner )

Construct null from owner.

Definition at line 32 of file DampingModel.C.

Referenced by DampingModel< Foam::MPPICCloud< CloudType > >::DampingModel().

Here is the caller graph for this function:

◆ DampingModel() [2/3]

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

Construct from components.

Definition at line 41 of file DampingModel.C.

◆ DampingModel() [3/3]

DampingModel ( const DampingModel< CloudType > & cm )

Construct copy.

Definition at line 59 of file DampingModel.C.

◆ ~DampingModel()

~DampingModel ( )

virtual

Destructor.

Definition at line 69 of file DampingModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "dampingModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		DampingModel< CloudType >	,
		dictionary	,
		(const dictionary &dict, CloudType &owner)	,
		(dict, owner)
	)

Declare runtime constructor selection table.

◆ clone()

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

pure virtual

Construct and return a clone.

Implemented in Relaxation< CloudType >, and NoDamping< CloudType >.

◆ New()

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

static

Selector.

Definition at line 78 of file DampingModel.C.

Referenced by DampingModel< Foam::MPPICCloud< CloudType > >::~DampingModel().

Here is the caller graph for this function:

◆ velocityCorrection()

virtual vector velocityCorrection	(	typename CloudType::parcelType &	p,
		const scalar	deltaT
	)		const

pure virtual

Calculate the velocity correction.

Implemented in Relaxation< CloudType >, and NoDamping< CloudType >.

Member Data Documentation

◆ timeScaleModel_

autoPtr<TimeScaleModel> timeScaleModel_

protected

Time scale model.

Definition at line 66 of file DampingModel.H.

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

src/lagrangian/parcel/clouds/Templates/MPPICCloud/MPPICCloud.H
src/lagrangian/parcel/submodels/MPPIC/DampingModels/DampingModel/DampingModel.H
src/lagrangian/parcel/submodels/MPPIC/DampingModels/DampingModel/DampingModel.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members