Base class for dispersion modelling. More...

#include <DispersionModel.H>

Inheritance diagram for DispersionModel< CloudType >:

[legend]

Collaboration diagram for DispersionModel< CloudType >:

Public Member Functions
	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 autoPtr< DispersionModel< CloudType > >	clone () const =0
	Construct and return a clone.
virtual	~DispersionModel ()
	Destructor.
virtual vector	update (const scalar dt, const label celli, const vector &U, const vector &Uc, vector &UTurb, scalar &tTurb)=0
	Update (disperse particles).
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 bool	active () const
	Return the model 'active' status - default active = true.
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.

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

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for.
Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info.
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line.
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::DispersionModel< CloudType >

Base class for dispersion modelling.

Definition at line 48 of file DispersionModel.H.

Constructor & Destructor Documentation

◆ DispersionModel() [1/3]

template<class CloudType>

DispersionModel ( CloudType & owner )

Construct null from owner.

Definition at line 26 of file DispersionModel.C.

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

Referenced by declareRunTimeSelectionTable(), DispersionModel(), DispersionRASModel< CloudType >::DispersionRASModel(), DispersionRASModel< CloudType >::DispersionRASModel(), NoDispersion< CloudType >::NoDispersion(), and NoDispersion< CloudType >::NoDispersion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DispersionModel() [2/3]

template<class CloudType>

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

Construct from components.

Definition at line 33 of file DispersionModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), subModelBase::dict(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

◆ DispersionModel() [3/3]

template<class CloudType>

DispersionModel ( const DispersionModel< CloudType > & dm )

Construct copy.

Definition at line 45 of file DispersionModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), and DispersionModel().

Here is the call graph for this function:

◆ ~DispersionModel()

template<class CloudType>

~DispersionModel ( )

virtual

Destructor.

Definition at line 57 of file DispersionModel.C.

Member Function Documentation

◆ TypeName()

template<class CloudType>

TypeName ( "dispersionModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

template<class CloudType>

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

References subModelBase::dict(), DispersionModel(), 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.

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

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

Here is the call graph for this function:

◆ New()

template<class CloudType>

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

static

Selector.

Definition at line 28 of file DispersionModelNew.C.

References subModelBase::dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, subModelBase::modelType(), and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

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

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

References U.

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

src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.H
src/lagrangian/intermediate/submodels/Kinematic/DispersionModel/DispersionModel/DispersionModel.H
src/lagrangian/intermediate/submodels/Kinematic/DispersionModel/DispersionModel/DispersionModel.C
src/lagrangian/intermediate/submodels/Kinematic/DispersionModel/DispersionModel/DispersionModelNew.C

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DispersionModel() [1/3]

◆ DispersionModel() [2/3]

◆ DispersionModel() [3/3]

◆ ~DispersionModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ update()