CloudFunctionObject< CloudType > Class Template Reference

Templated cloud function object base class. More...

Inheritance diagram for CloudFunctionObject< CloudType >:
[legend]
Collaboration diagram for CloudFunctionObject< CloudType >:
[legend]

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 ()=default
 Destructor. More...
 
virtual void preEvolve (const typename parcelType::trackingData &td)
 Pre-evolve hook. More...
 
virtual void postEvolve (const typename parcelType::trackingData &td)
 Post-evolve hook. More...
 
virtual void postMove (parcelType &p, const scalar dt, const point &position0, bool &keepParticle)
 Post-move hook. More...
 
virtual void postPatch (const parcelType &p, const polyPatch &pp, bool &keepParticle)
 Post-patch hook. More...
 
virtual void postFace (const parcelType &p, bool &keepParticle)
 Post-face hook. More...
 
const fileNameoutputDir () 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)
 Construct as copy. More...
 
virtual ~CloudSubModelBase ()
 Destructor. More...
 
const CloudTypeowner () 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...
 
CloudTypeowner ()
 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)
 Construct as copy. More...
 
virtual ~subModelBase ()
 Destructor. More...
 
const wordmodelName () const
 Return const access to the name of the sub-model. More...
 
const dictionarydict () const
 Return const access to the cloud dictionary. More...
 
const wordbaseName () const
 Return const access to the base name of the sub-model. More...
 
const wordmodelType () const
 Return const access to the sub-model type. More...
 
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionaryproperties () 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...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. 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...
 
virtual void write (Ostream &os) const
 Write. 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 >
CloudTypeowner_
 Reference to the cloud. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 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 62 of file CloudFunctionObject.H.

Constructor & Destructor Documentation

◆ CloudFunctionObject() [1/3]

Construct null from owner.

Definition at line 44 of file CloudFunctionObject.C.

◆ CloudFunctionObject() [2/3]

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

Construct from dictionary.

Definition at line 52 of file CloudFunctionObject.C.

References fileName::clean(), TimePaths::globalPath(), CloudSubModelBase< CloudType >::localPath(), DSMCCloud< ParcelType >::mesh(), functionObject::outputPrefix, CloudSubModelBase< CloudType >::owner(), and fvMesh::time().

Here is the call graph for this function:

◆ CloudFunctionObject() [3/3]

Construct copy.

Definition at line 78 of file CloudFunctionObject.C.

◆ ~CloudFunctionObject()

virtual ~CloudFunctionObject ( )
virtualdefault

Destructor.

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

◆ New()

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

Selector.

Definition at line 35 of file CloudFunctionObjectNew.C.

References Foam::abort(), dict, Foam::endl(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::Info.

Here is the call graph for this function:

◆ preEvolve()

◆ postEvolve()

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

Post-evolve hook.

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

Definition at line 99 of file CloudFunctionObject.C.

References write().

Here is the call graph for this function:

◆ postMove()

void postMove ( parcelType &  p,
const scalar  dt,
const point position0,
bool keepParticle 
)
virtual

Post-move hook.

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

Definition at line 112 of file CloudFunctionObject.C.

◆ postPatch()

void postPatch ( const parcelType &  p,
const polyPatch pp,
bool keepParticle 
)
virtual

Post-patch hook.

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

Definition at line 123 of file CloudFunctionObject.C.

◆ postFace()

void postFace ( const parcelType &  p,
bool keepParticle 
)
virtual

Post-face hook.

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

Definition at line 133 of file CloudFunctionObject.C.

◆ outputDir()

const Foam::fileName & outputDir

Return the output path.

Definition at line 142 of file CloudFunctionObject.C.

◆ writeTimeDir()

Foam::fileName writeTimeDir

Return the output time path.

Definition at line 149 of file CloudFunctionObject.C.


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