Templated cloud function object base class. More...

Inheritance diagram for CloudFunctionObject< CloudType >:

[legend]

Collaboration diagram for CloudFunctionObject< CloudType >:

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

	declareRunTimeSelectionTable (autoPtr, CloudFunctionObject, dictionary,(const dictionary &dict, CloudType &owner, const word &modelName),(dict, owner, modelName))
	Declare runtime constructor selection table. More...

	CloudFunctionObject (CloudType &owner)
	Construct null from owner. More...

	CloudFunctionObject (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)
	Construct from dictionary. More...

	CloudFunctionObject (const CloudFunctionObject< CloudType > &ppm)
	Construct copy. More...

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

virtual	~CloudFunctionObject ()
	Destructor. More...

virtual void	preEvolve ()
	Pre-evolve hook. More...

virtual void	postEvolve ()
	Post-evolve hook. More...

virtual void	postMove (typename CloudType::parcelType &p, const scalar dt, const point &position0, bool &keepParticle)
	Post-move hook. More...

virtual void	postPatch (const typename CloudType::parcelType &p, const polyPatch &pp, bool &keepParticle)
	Post-patch hook. More...

virtual void	postFace (const typename CloudType::parcelType &p, bool &keepParticle)
	Post-face hook. More...

const fileName &	outputDir () const
	Return the output path. More...

fileName	writeTimeDir () const
	Return the output time path. 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)
	Copy constructor. 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)
	Copy constructor. 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 void	cacheFields (const bool store)
	Cache dependent sub-model fields. 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...

void	operator= (const subModelBase &)=delete
	Disallow default bitwise assignment. More...

Static Public Member Functions
static autoPtr< CloudFunctionObject< CloudType > >	New (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)
	Selector. More...

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for. 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 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::CloudFunctionObject< CloudType >

Templated cloud function object base class.

Source files

Definition at line 56 of file CloudFunctionObject.H.

Constructor & Destructor Documentation

◆ CloudFunctionObject() [1/3]

CloudFunctionObject ( CloudType & owner )

Construct null from owner.

Definition at line 40 of file CloudFunctionObject.C.

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

Here is the caller graph for this function:

◆ CloudFunctionObject() [2/3]

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

Construct from dictionary.

Definition at line 49 of file CloudFunctionObject.C.

References CloudFunctionObject< CloudType >::CloudFunctionObject(), subModelBase::modelName(), and cloud::prefix.

Here is the call graph for this function:

◆ CloudFunctionObject() [3/3]

CloudFunctionObject ( const CloudFunctionObject< CloudType > & ppm )

Construct copy.

Definition at line 68 of file CloudFunctionObject.C.

◆ ~CloudFunctionObject()

~CloudFunctionObject ( )

virtual

Destructor.

Definition at line 80 of file CloudFunctionObject.C.

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

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "cloudFunctionObject" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Reimplemented in ParticleCollector< CloudType >, ParticleErosion< CloudType >, FacePostProcessing< CloudType >, PatchCollisionDensity< CloudType >, ParticleTracks< CloudType >, ParticleTrap< CloudType >, PatchPostProcessing< CloudType >, VoidFraction< CloudType >, and RelativeVelocity< CloudType >.

Definition at line 113 of file CloudFunctionObject.H.

References CloudFunctionObject< CloudType >::New(), CloudFunctionObject< CloudType >::outputDir(), p, CloudFunctionObject< CloudType >::postEvolve(), CloudFunctionObject< CloudType >::postFace(), CloudFunctionObject< CloudType >::postMove(), CloudFunctionObject< CloudType >::postPatch(), CloudFunctionObject< CloudType >::preEvolve(), CloudFunctionObject< CloudType >::writeTimeDir(), and CloudFunctionObject< CloudType >::~CloudFunctionObject().

Here is the call graph for this function:

◆ New()

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

static

Selector.

Definition at line 33 of file CloudFunctionObjectNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, and Foam::nl.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preEvolve()

void preEvolve ( )

virtual

Pre-evolve hook.

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

Definition at line 87 of file CloudFunctionObject.C.

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

Here is the caller graph for this function:

◆ postEvolve()

void postEvolve ( )

virtual

Post-evolve hook.

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

Definition at line 92 of file CloudFunctionObject.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ postMove()

void postMove	(	typename CloudType::parcelType &	p,
		const scalar	dt,
		const point &	position0,
		bool &	keepParticle
	)

virtual

Post-move hook.

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

Definition at line 103 of file CloudFunctionObject.C.

References CloudFunctionObject< CloudType >::postPatch().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ postPatch()

void postPatch	(	const typename CloudType::parcelType &	p,
		const polyPatch &	pp,
		bool &	keepParticle
	)

virtual

Post-patch hook.

Definition at line 114 of file CloudFunctionObject.C.

References CloudFunctionObject< CloudType >::postFace().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ postFace()

void postFace	(	const typename CloudType::parcelType &	p,
		bool &	keepParticle
	)

virtual

Post-face hook.

Definition at line 124 of file CloudFunctionObject.C.

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

Here is the caller graph for this function:

◆ outputDir()

const Foam::fileName & outputDir ( ) const

Return the output path.

Definition at line 132 of file CloudFunctionObject.C.

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

Here is the caller graph for this function:

◆ writeTimeDir()

Foam::fileName writeTimeDir ( ) const

Return the output time path.

Definition at line 139 of file CloudFunctionObject.C.

References CloudSubModelBase< CloudType >::owner(), objectRegistry::time(), and Time::timeName().

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

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/parcel/submodels/CloudFunctionObjects/CloudFunctionObject/CloudFunctionObject.H
src/lagrangian/parcel/submodels/CloudFunctionObjects/CloudFunctionObject/CloudFunctionObject.C
src/lagrangian/parcel/submodels/CloudFunctionObjects/CloudFunctionObject/CloudFunctionObjectNew.C

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::CloudFunctionObject< CloudType >

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()

template<class CloudType>
class Foam::CloudFunctionObject< CloudType >