Templated cloud function object base class. More...
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 bool | active () const |
Return the model 'active' status - default active = true. 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... | |
Templated cloud function object base class.
Definition at line 56 of file CloudFunctionObject.H.
CloudFunctionObject | ( | CloudType & | owner | ) |
Construct null from owner.
Definition at line 40 of file CloudFunctionObject.C.
Referenced by CloudFunctionObject< CloudType >::CloudFunctionObject().
CloudFunctionObject | ( | const dictionary & | dict, |
CloudType & | owner, | ||
const word & | objectType, | ||
const word & | modelName | ||
) |
Construct from dictionary.
Definition at line 49 of file CloudFunctionObject.C.
References fileName::clean(), CloudFunctionObject< CloudType >::CloudFunctionObject(), subModelBase::modelName(), UPstream::parRun(), and cloud::prefix.
CloudFunctionObject | ( | const CloudFunctionObject< CloudType > & | ppm | ) |
Construct copy.
Definition at line 79 of file CloudFunctionObject.C.
|
virtual |
Destructor.
Definition at line 91 of file CloudFunctionObject.C.
Referenced by CloudFunctionObject< CloudType >::clone().
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.
|
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().
|
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().
|
virtual |
Pre-evolve hook.
Reimplemented in ParticleErosion< CloudType >, ParticleTracks< CloudType >, ParticleTrap< CloudType >, and VoidFraction< CloudType >.
Definition at line 98 of file CloudFunctionObject.C.
Referenced by CloudFunctionObject< CloudType >::clone().
|
virtual |
Post-evolve hook.
Reimplemented in ParticleTrap< CloudType >, and VoidFraction< CloudType >.
Definition at line 103 of file CloudFunctionObject.C.
References CloudSubModelBase< CloudType >::owner(), CloudFunctionObject< CloudType >::postMove(), and CloudSubModelBase< CloudType >::writeTime().
Referenced by CloudFunctionObject< CloudType >::clone().
|
virtual |
Post-move hook.
Reimplemented in ParticleCollector< CloudType >, ParticleTrap< CloudType >, and VoidFraction< CloudType >.
Definition at line 114 of file CloudFunctionObject.C.
References CloudFunctionObject< CloudType >::postPatch().
Referenced by CloudFunctionObject< CloudType >::clone(), and CloudFunctionObject< CloudType >::postEvolve().
|
virtual |
Post-patch hook.
Definition at line 125 of file CloudFunctionObject.C.
References CloudFunctionObject< CloudType >::postFace().
Referenced by CloudFunctionObject< CloudType >::clone(), and CloudFunctionObject< CloudType >::postMove().
|
virtual |
Post-face hook.
Definition at line 135 of file CloudFunctionObject.C.
Referenced by CloudFunctionObject< CloudType >::clone(), and CloudFunctionObject< CloudType >::postPatch().
const Foam::fileName & outputDir | ( | ) | const |
Return the output path.
Definition at line 143 of file CloudFunctionObject.C.
Referenced by CloudFunctionObject< CloudType >::clone().
Foam::fileName writeTimeDir | ( | ) | const |
Return the output time path.
Definition at line 150 of file CloudFunctionObject.C.
References CloudSubModelBase< CloudType >::owner(), objectRegistry::time(), and Time::timeName().
Referenced by CloudFunctionObject< CloudType >::clone().