Templated cloud function object base class. More...

#include <CloudFunctionObject.H>

Inheritance diagram for CloudFunctionObject< CloudType >:

[legend]

Collaboration diagram for CloudFunctionObject< CloudType >:

Public Member Functions
	TypeName ("cloudFunctionObject")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, CloudFunctionObject, dictionary,(const dictionary &dict, CloudType &owner, const word &modelName),(dict, owner, modelName))
	Declare runtime constructor selection table.
	CloudFunctionObject (CloudType &owner)
	Construct null from owner.
	CloudFunctionObject (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)
	Construct from dictionary.
	CloudFunctionObject (const CloudFunctionObject< CloudType > &ppm)
	Construct copy.
virtual autoPtr< CloudFunctionObject< CloudType > >	clone () const
	Construct and return a clone.
virtual	~CloudFunctionObject ()=default
	Destructor.
virtual void	preEvolve (const typename parcelType::trackingData &td)
	Pre-evolve hook.
virtual void	postEvolve (const typename parcelType::trackingData &td)
	Post-evolve hook.
virtual bool	postMove (parcelType &p, const scalar dt, const point &position0, const typename parcelType::trackingData &td)
	Post-move hook.
virtual bool	postPatch (const parcelType &p, const polyPatch &pp, const typename parcelType::trackingData &td)
	Post-patch hook.
virtual bool	postFace (const parcelType &p, const typename parcelType::trackingData &td)
	Post-face hook.
const fileName &	outputDir () const
	Return the output path.
fileName	writeTimeDir () const
	Return the output time path.
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< CloudFunctionObject< CloudType > >	New (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)
	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::CloudFunctionObject< CloudType >

Templated cloud function object base class.

Source files

Definition at line 58 of file CloudFunctionObject.H.

Constructor & Destructor Documentation

◆ CloudFunctionObject() [1/3]

template<class CloudType>

CloudFunctionObject ( CloudType & owner )

Construct null from owner.

Definition at line 37 of file CloudFunctionObject.C.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CloudFunctionObject() [2/3]

template<class CloudType>

CloudFunctionObject	(	const dictionary &	dict,
		CloudType &	owner,
		const word &	objectType,
		const word &	modelName )

Construct from dictionary.

Definition at line 45 of file CloudFunctionObject.C.

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

Here is the call graph for this function:

◆ CloudFunctionObject() [3/3]

template<class CloudType>

CloudFunctionObject ( const CloudFunctionObject< CloudType > & ppm )

Construct copy.

Definition at line 71 of file CloudFunctionObject.C.

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

Here is the call graph for this function:

◆ ~CloudFunctionObject()

template<class CloudType>

virtual ~CloudFunctionObject ( )

virtualdefault

Destructor.

References subModelBase::dict(), subModelBase::modelName(), CloudSubModelBase< CloudType >::owner(), p, pp(), and td().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

template<class CloudType>

TypeName ( "cloudFunctionObject" )

Runtime type information.

◆ declareRunTimeSelectionTable()

template<class CloudType>

declareRunTimeSelectionTable	(	autoPtr	,
		CloudFunctionObject< CloudType >	,
		dictionary	,
		(const dictionary &dict, CloudType &owner, const word &modelName)	,
		(dict, owner, modelName)	)

Declare runtime constructor selection table.

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

Here is the call graph for this function:

◆ clone()

template<class CloudType>

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

inlinevirtual

Construct and return a clone.

Definition at line 140 of file CloudFunctionObject.H.

References CloudFunctionObject().

Here is the call graph for this function:

◆ New()

template<class CloudType>

Foam::autoPtr< Foam::CloudFunctionObject< CloudType > > New	(	const dictionary &	dict,
		CloudType &	owner,
		const word &	objectType,
		const word &	modelName )

static

Selector.

Definition at line 28 of file CloudFunctionObjectNew.C.

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

Referenced by CloudFunctionObjectList< CloudType >::CloudFunctionObjectList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preEvolve()

template<class CloudType>

void preEvolve ( const typename parcelType::trackingData & td )

virtual

Pre-evolve hook.

Reimplemented in FreezeParticles< CloudType >, ParticleErosion< CloudType >, ParticleTracks< CloudType >, ParticleTrap< CloudType >, ParticleZoneInfo< CloudType >, PatchInteractionFields< CloudType >, and VoidFraction< CloudType >.

Definition at line 84 of file CloudFunctionObject.C.

References td().

Here is the call graph for this function:

◆ postEvolve()

template<class CloudType>

void postEvolve ( const typename parcelType::trackingData & td )

virtual

Post-evolve hook.

Reimplemented in HeatTransferCoeff< CloudType >, KinematicReynoldsNumber< CloudType >, KinematicWeberNumber< CloudType >, NusseltNumber< CloudType >, ParticleDose< CloudType >, ParticleTrap< CloudType >, ParticleZoneInfo< CloudType >, ReactingWeberNumber< CloudType >, RemoveParcels< CloudType >, ThermoReynoldsNumber< CloudType >, and VoidFraction< CloudType >.

Definition at line 92 of file CloudFunctionObject.C.

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

Referenced by ParticleZoneInfo< CloudType >::postEvolve(), RemoveParcels< CloudType >::postEvolve(), and VoidFraction< CloudType >::postEvolve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ postMove()

template<class CloudType>

bool postMove	(	parcelType &	p,
		const scalar	dt,
		const point &	position0,
		const typename parcelType::trackingData &	td )

virtual

Post-move hook.

Reimplemented in ParticleTrap< CloudType >, ParticleZoneInfo< CloudType >, and VoidFraction< CloudType >.

Definition at line 105 of file CloudFunctionObject.C.

References td().

Here is the call graph for this function:

◆ postPatch()

template<class CloudType>

bool postPatch	(	const parcelType &	p,
		const polyPatch &	pp,
		const typename parcelType::trackingData &	td )

virtual

Post-patch hook.

Reimplemented in ParticleErosion< CloudType >, and PatchInteractionFields< CloudType >.

Definition at line 118 of file CloudFunctionObject.C.

◆ postFace()

template<class CloudType>

bool postFace	(	const parcelType &	p,
		const typename parcelType::trackingData &	td )

virtual

Post-face hook.

Reimplemented in ParticleTracks< CloudType >, and RemoveParcels< CloudType >.

Definition at line 130 of file CloudFunctionObject.C.

References td().

Here is the call graph for this function:

◆ outputDir()

template<class CloudType>

const Foam::fileName & outputDir ( ) const

Return the output path.

Definition at line 141 of file CloudFunctionObject.C.

◆ writeTimeDir()

template<class CloudType>

Foam::fileName writeTimeDir ( ) const

Return the output time path.

Definition at line 148 of file CloudFunctionObject.C.

References CloudSubModelBase< CloudType >::owner().

Referenced by FacePostProcessing< CloudType >::write(), and ParticleCollector< CloudType >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

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

src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudFunctionObject/CloudFunctionObject.H
src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudFunctionObject/CloudFunctionObject.C
src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudFunctionObject/CloudFunctionObjectNew.C

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CloudFunctionObject() [1/3]

◆ CloudFunctionObject() [2/3]

◆ CloudFunctionObject() [3/3]

◆ ~CloudFunctionObject()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ preEvolve()

◆ postEvolve()

◆ postMove()

◆ postPatch()

◆ postFace()

◆ outputDir()

◆ writeTimeDir()