Base class for particle dispersion models based on RAS turbulence. More...

#include <DispersionRASModel.H>

Inheritance diagram for DispersionRASModel< CloudType >:

[legend]

Collaboration diagram for DispersionRASModel< CloudType >:

[legend]

Public Member Functions
	TypeName ("dispersionRASModel")
	Runtime type information.
	DispersionRASModel (const dictionary &dict, CloudType &owner)
	Construct from components.
	DispersionRASModel (const DispersionRASModel< CloudType > &dm)
	Construct copy.
virtual autoPtr< DispersionModel< CloudType > >	clone () const =0
	Construct and return a clone.
virtual	~DispersionRASModel ()
	Destructor.
virtual vector	update (const scalar dt, const label celli, const vector &U, const vector &Uc, vector &UTurb, scalar &tTurb)=0
	Update (disperse particles).
virtual void	cacheFields (const bool store)
	Cache carrier fields.
virtual void	write (Ostream &os) const
	Write.
Public Member Functions inherited from DispersionModel< CloudType >
	TypeName ("dispersionModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, DispersionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	DispersionModel (CloudType &owner)
	Construct null from owner.
	DispersionModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from components.
	DispersionModel (const DispersionModel< CloudType > &dm)
	Construct copy.
virtual	~DispersionModel ()
	Destructor.
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.
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 bool	active () const
	Return the model 'active' status - default active = true.
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
tmp< volScalarField >	kModel () const
	Return the k field from the turbulence model.
tmp< volScalarField >	epsilonModel () const
	Return the epsilon field from the turbulence model.
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line.

Protected Attributes
const volScalarField *	kPtr_
	Turbulence k.
const volScalarField *	epsilonPtr_
	Turbulence epsilon.
bool	ownK_
	Local ownership of the k field.
bool	ownEpsilon_
	Local ownership of the epsilon field.
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.

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 DispersionModel< CloudType >
static autoPtr< DispersionModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector.
Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info.

Detailed Description

template<class CloudType>
class Foam::DispersionRASModel< CloudType >

Base class for particle dispersion models based on RAS turbulence.

Definition at line 43 of file DispersionRASModel.H.

Constructor & Destructor Documentation

◆ DispersionRASModel() [1/2]

template<class CloudType>

DispersionRASModel	(	const dictionary &	dict,
		CloudType &	owner )

Construct from components.

Definition at line 86 of file DispersionRASModel.C.

References DispersionModel< CloudType >::DispersionModel(), epsilonPtr_, kPtr_, ownEpsilon_, CloudSubModelBase< CloudType >::owner(), and ownK_.

Referenced by DispersionRASModel(), GradientDispersionRAS< CloudType >::GradientDispersionRAS(), GradientDispersionRAS< CloudType >::GradientDispersionRAS(), StochasticDispersionRAS< CloudType >::StochasticDispersionRAS(), StochasticDispersionRAS< CloudType >::StochasticDispersionRAS(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DispersionRASModel() [2/2]

template<class CloudType>

DispersionRASModel ( const DispersionRASModel< CloudType > & dm )

Construct copy.

Definition at line 101 of file DispersionRASModel.C.

References DispersionModel< CloudType >::DispersionModel(), DispersionRASModel(), epsilonPtr_, kPtr_, ownEpsilon_, and ownK_.

Here is the call graph for this function:

◆ ~DispersionRASModel()

template<class CloudType>

~DispersionRASModel ( )

virtual

Destructor.

Definition at line 120 of file DispersionRASModel.C.

References cacheFields().

Here is the call graph for this function:

Member Function Documentation

◆ kModel()

template<class CloudType>

Foam::tmp< Foam::volScalarField > kModel ( ) const

protected

Return the k field from the turbulence model.

Definition at line 29 of file DispersionRASModel.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, objectRegistry::findObject(), IOobject::groupName(), Foam::nl, CloudSubModelBase< CloudType >::owner(), turbulenceModel::propertiesName, HashTable< T, Key, Hash >::sortedToc(), turb, and U.

Referenced by cacheFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ epsilonModel()

template<class CloudType>

Foam::tmp< Foam::volScalarField > epsilonModel ( ) const

protected

Return the epsilon field from the turbulence model.

Definition at line 57 of file DispersionRASModel.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, objectRegistry::findObject(), IOobject::groupName(), Foam::nl, CloudSubModelBase< CloudType >::owner(), turbulenceModel::propertiesName, HashTable< T, Key, Hash >::sortedToc(), turb, and U.

Referenced by cacheFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

template<class CloudType>

TypeName ( "dispersionRASModel" )

Runtime type information.

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

Here is the call graph for this function:

◆ clone()

template<class CloudType>

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

pure virtual

Construct and return a clone.

Implements DispersionModel< CloudType >.

Implemented in GradientDispersionRAS< CloudType >, and StochasticDispersionRAS< CloudType >.

◆ update()

template<class CloudType>

virtual vector update	(	const scalar	dt,
		const label	celli,
		const vector &	U,
		const vector &	Uc,
		vector &	UTurb,
		scalar &	tTurb )

pure virtual

Update (disperse particles).

Implements DispersionModel< CloudType >.

Implemented in GradientDispersionRAS< CloudType >, and StochasticDispersionRAS< CloudType >.

References os(), and U.

Here is the call graph for this function:

◆ cacheFields()

template<class CloudType>

void cacheFields ( const bool store )

virtual

Cache carrier fields.

Reimplemented from subModelBase.

Reimplemented in GradientDispersionRAS< CloudType >.

Definition at line 129 of file DispersionRASModel.C.

References tmp< T >::cref(), Foam::deleteDemandDrivenData(), epsilonModel(), epsilonPtr_, kModel(), kPtr_, tmp< T >::movable(), ownEpsilon_, ownK_, and tmp< T >::ptr().

Referenced by GradientDispersionRAS< CloudType >::cacheFields(), and ~DispersionRASModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

template<class CloudType>

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from CloudSubModelBase< CloudType >.

Definition at line 176 of file DispersionRASModel.C.

References os(), ownEpsilon_, ownK_, and CloudSubModelBase< CloudType >::write().

Here is the call graph for this function:

Member Data Documentation

◆ kPtr_

template<class CloudType>

const volScalarField* kPtr_

protected

Turbulence k.

Definition at line 56 of file DispersionRASModel.H.

Referenced by cacheFields(), GradientDispersionRAS< CloudType >::cacheFields(), DispersionRASModel(), DispersionRASModel(), GradientDispersionRAS< CloudType >::update(), and StochasticDispersionRAS< CloudType >::update().

◆ epsilonPtr_

template<class CloudType>

const volScalarField* epsilonPtr_

protected

Turbulence epsilon.

Definition at line 61 of file DispersionRASModel.H.

Referenced by cacheFields(), DispersionRASModel(), DispersionRASModel(), GradientDispersionRAS< CloudType >::update(), and StochasticDispersionRAS< CloudType >::update().

◆ ownK_

template<class CloudType>

bool ownK_

mutableprotected

Local ownership of the k field.

Definition at line 66 of file DispersionRASModel.H.

Referenced by cacheFields(), DispersionRASModel(), DispersionRASModel(), and write().

◆ ownEpsilon_

template<class CloudType>

bool ownEpsilon_

mutableprotected

Local ownership of the epsilon field.

Definition at line 71 of file DispersionRASModel.H.

Referenced by cacheFields(), DispersionRASModel(), DispersionRASModel(), and write().

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

src/lagrangian/turbulence/submodels/Kinematic/DispersionModel/DispersionRASModel/DispersionRASModel.H
src/lagrangian/turbulence/submodels/Kinematic/DispersionModel/DispersionRASModel/DispersionRASModel.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DispersionRASModel() [1/2]

◆ DispersionRASModel() [2/2]

◆ ~DispersionRASModel()

Member Function Documentation

◆ kModel()

◆ epsilonModel()

◆ TypeName()

◆ clone()

◆ update()

◆ cacheFields()

◆ write()

Member Data Documentation

◆ kPtr_

◆ epsilonPtr_

◆ ownK_

◆ ownEpsilon_