Public Member Functions | Static Public Member Functions | List of all members
CloudFunctionObject< CloudType > Class Template Reference
Lagrangian particle models » Submodels » Function objects

Templated cloud function object base class. More...

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

Public Member Functions

 TypeName ("cloudFunctionObject")
 
 declareRunTimeSelectionTable (autoPtr, CloudFunctionObject, dictionary,(const dictionary &dict, CloudType &owner, const word &modelName),(dict, owner, modelName))
 
 CloudFunctionObject (CloudType &owner)
 
 CloudFunctionObject (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)
 
 CloudFunctionObject (const CloudFunctionObject< CloudType > &ppm)
 
virtual autoPtr< CloudFunctionObject< CloudType > > clone () const
 
virtual ~CloudFunctionObject ()=default
 
virtual void preEvolve (const typename parcelType::trackingData &td)
 
virtual void postEvolve (const typename parcelType::trackingData &td)
 
virtual void postMove (parcelType &p, const scalar dt, const point &position0, bool &keepParticle)
 
virtual void postPatch (const parcelType &p, const polyPatch &pp, bool &keepParticle)
 
virtual void postFace (const parcelType &p, bool &keepParticle)
 
const fileName & outputDir () const
 
fileName writeTimeDir () const
 
- Public Member Functions inherited from CloudSubModelBase< CloudType >
 CloudSubModelBase (CloudType &owner)
 
 CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 
 CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
 
 CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
 
virtual ~CloudSubModelBase ()
 
const CloudType & owner () const
 
virtual bool writeTime () const
 
virtual fileName localPath () const
 
CloudType & owner ()
 
virtual void write (Ostream &os) const
 
- Public Member Functions inherited from subModelBase
 subModelBase (dictionary &properties)
 
 subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 
 subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
 
 subModelBase (const subModelBase &smb)
 
virtual ~subModelBase ()
 
const word & modelName () const
 
const dictionary & dict () const
 
const word & baseName () const
 
const word & modelType () const
 
const dictionary & coeffDict () const
 
const dictionary & properties () const
 
virtual bool defaultCoeffs (const bool printMsg) const
 
virtual bool active () const
 
virtual void cacheFields (const bool store)
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
void getBaseProperty (const word &entryName, Type &value) const
 
template<class Type >
void setBaseProperty (const word &entryName, const Type &value)
 
bool getModelDict (const word &entryName, dictionary &dict) const
 
template<class Type >
void getModelProperty (const word &entryName, Type &value) const
 
template<class Type >
Type getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
void setModelProperty (const word &entryName, const Type &value)
 

Static Public Member Functions

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

Additional Inherited Members

- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 
- Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType & owner_
 
- Protected Attributes inherited from subModelBase
const word modelName_
 
dictionary & properties_
 
const dictionary dict_
 
const word baseName_
 
const word modelType_
 
const dictionary coeffDict_
 

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]

CloudFunctionObject ( CloudType &  owner)

Definition at line 37 of file CloudFunctionObject.C.

◆ CloudFunctionObject() [2/3]

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

Definition at line 46 of file CloudFunctionObject.C.

References TimePaths::globalPath(), DSMCCloud< ParcelType >::mesh(), functionObject::outputPrefix, and fvMesh::time().

Here is the call graph for this function:

◆ CloudFunctionObject() [3/3]

CloudFunctionObject ( const CloudFunctionObject< CloudType > &  ppm)

Definition at line 72 of file CloudFunctionObject.C.

◆ ~CloudFunctionObject()

virtual ~CloudFunctionObject ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "cloudFunctionObject"  )

◆ declareRunTimeSelectionTable()

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

◆ clone()

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

Reimplemented in ParticleCollector< CloudType >, PatchParticleHistogram< CloudType >, ThermoReynoldsNumber< CloudType >, KinematicReynoldsNumber< CloudType >, FaceInteraction< CloudType >, PatchInteractionFields< CloudType >, HeatTransferCoeff< CloudType >, NusseltNumber< CloudType >, RemoveParcels< CloudType >, FacePostProcessing< CloudType >, ParticleErosion< CloudType >, PatchPostProcessing< CloudType >, ParticleTrap< CloudType >, PatchCollisionDensity< CloudType >, ParticleTracks< CloudType >, VoidFraction< CloudType >, and WeberNumberReacting< CloudType >.

Definition at line 120 of file CloudFunctionObject.H.

◆ New()

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

Definition at line 29 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()

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

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

Definition at line 85 of file CloudFunctionObject.C.

◆ postEvolve()

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

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

Definition at line 93 of file CloudFunctionObject.C.

References Foam::vtk::write().

Here is the call graph for this function:

◆ postMove()

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

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

Definition at line 106 of file CloudFunctionObject.C.

◆ postPatch()

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

Reimplemented in PatchParticleHistogram< CloudType >, PatchInteractionFields< CloudType >, PatchPostProcessing< CloudType >, ParticleErosion< CloudType >, and PatchCollisionDensity< CloudType >.

Definition at line 117 of file CloudFunctionObject.C.

◆ postFace()

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

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

Definition at line 127 of file CloudFunctionObject.C.

◆ outputDir()

const Foam::fileName & outputDir

Definition at line 135 of file CloudFunctionObject.C.

◆ writeTimeDir()

Foam::fileName writeTimeDir

Definition at line 142 of file CloudFunctionObject.C.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17