Public Member Functions | Static Public Member Functions | List of all members
CloudFunctionObject< CloudType > Class Template Reference

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")
 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 label cellI, const scalar dt, const point &position0, bool &keepParticle)
 Post-move hook. More...
 
virtual void postPatch (const typename CloudType::parcelType &p, const polyPatch &pp, const scalar trackFraction, const tetIndices &testIs, bool &keepParticle)
 Post-patch hook. More...
 
virtual void postFace (const typename CloudType::parcelType &p, const label faceI, bool &keepParticle)
 Post-face hook. More...
 
const fileNameoutputDir () const
 Return the output path. More...
 
fileName outputTimeDir () 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 outputTime () const
 Flag to indicate when to write a property. 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 dependant 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...
 

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 56 of file CloudFunctionObject.H.

Constructor & Destructor Documentation

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 ( 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(), UPstream::parRun(), and cloud::prefix.

Here is the call graph for this function:

Construct copy.

Definition at line 78 of file CloudFunctionObject.C.

~CloudFunctionObject ( )
virtual

Destructor.

Definition at line 90 of file CloudFunctionObject.C.

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

Here is the caller graph for this function:

Member Function Documentation

TypeName ( "cloudFunctionObject"  )

Runtime type information.

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

Declare runtime constructor selection table.

virtual autoPtr<CloudFunctionObject<CloudType> > clone ( ) const
inlinevirtual
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, FatalErrorIn, 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:

void preEvolve ( )
virtual

Pre-evolve hook.

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

Definition at line 97 of file CloudFunctionObject.C.

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

Here is the caller graph for this function:

void postEvolve ( )
virtual

Post-evolve hook.

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

Definition at line 104 of file CloudFunctionObject.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Post-move hook.

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

Definition at line 115 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:

void postPatch ( const typename CloudType::parcelType p,
const polyPatch pp,
const scalar  trackFraction,
const tetIndices testIs,
bool &  keepParticle 
)
virtual

Post-patch hook.

Definition at line 129 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:

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

Post-face hook.

Definition at line 143 of file CloudFunctionObject.C.

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

Here is the caller graph for this function:

const Foam::fileName & outputDir ( ) const

Return the output path.

Definition at line 154 of file CloudFunctionObject.C.

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

Here is the caller graph for this function:

Foam::fileName outputTimeDir ( ) const

Return the output time path.

Definition at line 161 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: