Relaxation collisional damping model. More...

Inheritance diagram for Relaxation< CloudType >:

Collaboration diagram for Relaxation< CloudType >:

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

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

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

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

virtual	~Relaxation ()
	Destructor. More...

virtual void	cacheFields (const bool store)
	Member Functions. More...

virtual vector	velocityCorrection (typename CloudType::parcelType &p, const scalar deltaT) const
	Calculate the velocity correction. More...

Public Member Functions inherited from DampingModel< CloudType >
	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	~DampingModel ()
	Destructor. 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...

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

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 DampingModel< CloudType >
static autoPtr< DampingModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector. More...

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

Protected Attributes inherited from DampingModel< CloudType >
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...

Detailed Description

template<class CloudType>
class Foam::DampingModels::Relaxation< CloudType >

Relaxation collisional damping model.

Particle velocities are relaxed towards the local mean over a time-scale.

Reference:

    "An improved collision damping time for MP-PIC calculations of dense
    particle flows with applications to polydisperse sedimenting beds and
    colliding particle jets"
    P O'Rourke and D Snider
    Chemical Engineering Science
    Volume 65, Issue 22, Pages 6014-6028, November 2010

Source files

Definition at line 63 of file Relaxation.H.

Constructor & Destructor Documentation

◆ Relaxation() [1/2]

Relaxation	(	const dictionary &	dict,
		CloudType &	owner
	)

Construct from components.

Definition at line 32 of file Relaxation.C.

◆ Relaxation() [2/2]

Relaxation ( const Relaxation< CloudType > & cm )

Construct copy.

Definition at line 45 of file Relaxation.C.

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

Here is the call graph for this function:

◆ ~Relaxation()

~Relaxation ( )

virtual

Destructor.

Definition at line 59 of file Relaxation.C.

Referenced by Relaxation< CloudType >::clone(), and Relaxation< CloudType >::Relaxation().

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "relaxation" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Implements DampingModel< CloudType >.

Definition at line 92 of file Relaxation.H.

References Relaxation< CloudType >::cacheFields(), p, Relaxation< CloudType >::velocityCorrection(), and Relaxation< CloudType >::~Relaxation().

Here is the call graph for this function:

◆ cacheFields()

void cacheFields ( const bool store )

virtual

Member Functions.

Calculate the damping time scales

Reimplemented from subModelBase.

Definition at line 66 of file Relaxation.C.

References PtrList< Field< Type > >::clear(), cloudName(), dict, objectRegistry::lookupObject(), mesh, timeName, and Relaxation< CloudType >::velocityCorrection().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ velocityCorrection()

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

virtual

Calculate the velocity correction.

Implements DampingModel< CloudType >.

Definition at line 137 of file Relaxation.C.

References x.

Referenced by Relaxation< CloudType >::cacheFields(), and Relaxation< CloudType >::clone().

Here is the caller graph for this function:

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

src/lagrangian/intermediate/submodels/MPPIC/DampingModels/Relaxation/Relaxation.H
src/lagrangian/intermediate/submodels/MPPIC/DampingModels/Relaxation/Relaxation.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::DampingModels::Relaxation< CloudType >

Constructor & Destructor Documentation

◆ Relaxation() [1/2]

◆ Relaxation() [2/2]

◆ ~Relaxation()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ cacheFields()

◆ velocityCorrection()

template<class CloudType>
class Foam::DampingModels::Relaxation< CloudType >