Base class for cloud sub-models. More...

Inheritance diagram for CloudSubModelBase< CloudType >:

[legend]

Collaboration diagram for CloudSubModelBase< CloudType >:

Public Types
typedef CloudType	cloudType
	Type of cloud this model was instantiated for. More...

Public Member Functions
	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 ()=default
	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...

virtual fileName	localPath () const
	Output directory. More...

CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation. More...

virtual void	info ()
	Write to info. More...

virtual void	write (Ostream &os) const
	Write to os. 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 ()=default
	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...

virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=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...

bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set. More...

template<class Type >
bool	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=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...

Protected Attributes
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 Attributes inherited from subModelBase
bool	log
	Flag to write log into Info. 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::CloudSubModelBase< CloudType >

Base class for cloud sub-models.

Source files

Definition at line 47 of file CloudSubModelBase.H.

Member Typedef Documentation

◆ cloudType

typedef CloudType cloudType

Type of cloud this model was instantiated for.

Definition at line 108 of file CloudSubModelBase.H.

Constructor & Destructor Documentation

◆ CloudSubModelBase() [1/4]

CloudSubModelBase ( CloudType & owner )

Construct null from owner cloud.

Definition at line 28 of file CloudSubModelBase.C.

◆ CloudSubModelBase() [2/4]

CloudSubModelBase	(	CloudType &	owner,
		const dictionary &	dict,
		const word &	baseName,
		const word &	modelType,
		const word &	dictExt = `"Coeffs"`
	)

Construct from owner cloud without name.

Definition at line 39 of file CloudSubModelBase.C.

◆ CloudSubModelBase() [3/4]

CloudSubModelBase	(	const word &	modelName,
		CloudType &	owner,
		const dictionary &	dict,
		const word &	baseName,
		const word &	modelType
	)

Construct from owner cloud with name.

Definition at line 63 of file CloudSubModelBase.C.

◆ CloudSubModelBase() [4/4]

CloudSubModelBase ( const CloudSubModelBase< CloudType > & smb )

Construct as copy.

Definition at line 87 of file CloudSubModelBase.C.

◆ ~CloudSubModelBase()

virtual ~CloudSubModelBase ( )

virtualdefault

Destructor.

Member Function Documentation

◆ owner() [1/2]

const CloudType & owner ( ) const

Return const access to the owner cloud.

Definition at line 101 of file CloudSubModelBase.C.

◆ writeTime()

bool writeTime ( ) const

virtual

Flag to indicate when to write a property.

Reimplemented from subModelBase.

Definition at line 115 of file CloudSubModelBase.C.

◆ localPath()

Foam::fileName localPath ( ) const

virtual

Output directory.

Reimplemented from subModelBase.

Definition at line 125 of file CloudSubModelBase.C.

◆ owner() [2/2]

CloudType & owner ( )

Return non-const access to the owner cloud for manipulation.

Definition at line 108 of file CloudSubModelBase.C.

◆ info()

void info ( )

virtual

Write to info.

Reimplemented in InjectionModel< CloudType >, KinematicSurfaceFilm< CloudType >, SurfaceFilmModel< CloudType >, SurfaceFilmModel< Foam::KinematicCloud< Foam::DSMCCloud > >, SurfaceFilmModel< Foam::KinematicCloud< CloudType > >, SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >, InjectedParticleDistributionInjection< CloudType >, RecycleInteraction< CloudType >, InjectedParticleInjection< CloudType >, PhaseChangeModel< CloudType >, PhaseChangeModel< Foam::ReactingCloud< CloudType > >, PhaseChangeModel< Foam::ReactingCloud< Foam::DSMCCloud > >, PatchInteractionModel< CloudType >, PatchInteractionModel< Foam::DSMCCloud >, PatchInteractionModel< Foam::KinematicCloud< Foam::DSMCCloud > >, PatchInteractionModel< Foam::KinematicCloud< CloudType > >, PatchInteractionModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >, ThermoSurfaceFilm< CloudType >, HeterogeneousReactingModel< CloudType >, HeterogeneousReactingModel< Foam::ReactingHeterogeneousCloud< Foam::DSMCCloud > >, HeterogeneousReactingModel< Foam::ReactingHeterogeneousCloud< CloudType > >, StandardWallInteraction< CloudType >, LocalInteraction< CloudType >, SurfaceReactionModel< CloudType >, SurfaceReactionModel< Foam::ReactingMultiphaseCloud< CloudType > >, SurfaceReactionModel< Foam::ReactingMultiphaseCloud< Foam::DSMCCloud > >, MultiInteraction< CloudType >, DevolatilisationModel< CloudType >, DevolatilisationModel< Foam::ReactingMultiphaseCloud< CloudType > >, and DevolatilisationModel< Foam::ReactingMultiphaseCloud< Foam::DSMCCloud > >.

Definition at line 137 of file CloudSubModelBase.C.

Referenced by InjectionModel< CloudType >::info().

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write to os.

Reimplemented from subModelBase.

Reimplemented in DispersionRASModel< CloudType >.

Definition at line 144 of file CloudSubModelBase.C.

Referenced by HeatTransferCoeff< CloudType >::postEvolve().

Here is the caller graph for this function:

Member Data Documentation

◆ owner_

CloudType& owner_

protected

Reference to the cloud.

Definition at line 58 of file CloudSubModelBase.H.

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

src/lagrangian/intermediate/submodels/CloudSubModelBase.H
src/lagrangian/intermediate/submodels/CloudSubModelBase.C

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::CloudSubModelBase< CloudType >

Member Typedef Documentation

◆ cloudType

Constructor & Destructor Documentation

◆ CloudSubModelBase() [1/4]

◆ CloudSubModelBase() [2/4]

◆ CloudSubModelBase() [3/4]

◆ CloudSubModelBase() [4/4]

◆ ~CloudSubModelBase()

Member Function Documentation

◆ owner() [1/2]

◆ writeTime()

◆ localPath()

◆ owner() [2/2]

◆ info()

◆ write()

Member Data Documentation

◆ owner_

template<class CloudType>
class Foam::CloudSubModelBase< CloudType >