Base class for generic sub-models requiring to be read from dictionary. Provides a mechanism to read and write properties from a dictionary to enable clean re-starts. Used by, e.g. clou dsub-models. More...
Public Member Functions | |
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... | |
virtual bool | writeTime () const =0 |
Flag to indicate when to write a property. 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... | |
virtual void | write (Ostream &os) const |
Write. More... | |
void | operator= (const subModelBase &)=delete |
Disallow default bitwise assignment. More... | |
Protected Member Functions | |
bool | inLine () const |
Flag to indicate whether data is/was read in-line. More... | |
Protected Attributes | |
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... | |
Base class for generic sub-models requiring to be read from dictionary. Provides a mechanism to read and write properties from a dictionary to enable clean re-starts. Used by, e.g. clou dsub-models.
Definition at line 51 of file subModelBase.H.
subModelBase | ( | dictionary & | properties | ) |
Construct null.
Definition at line 38 of file subModelBase.C.
subModelBase | ( | dictionary & | properties, |
const dictionary & | dict, | ||
const word & | baseName, | ||
const word & | modelType, | ||
const word & | dictExt = "Coeffs" |
||
) |
Construct from components without name.
Definition at line 49 of file subModelBase.C.
subModelBase | ( | const word & | modelName, |
dictionary & | properties, | ||
const dictionary & | dict, | ||
const word & | baseName, | ||
const word & | modelType | ||
) |
Construct from components with name.
Definition at line 67 of file subModelBase.C.
subModelBase | ( | const subModelBase & | smb | ) |
Copy constructor.
Definition at line 85 of file subModelBase.C.
|
virtual |
Destructor.
Definition at line 98 of file subModelBase.C.
|
protected |
Flag to indicate whether data is/was read in-line.
const Foam::word & modelName | ( | ) | const |
Return const access to the name of the sub-model.
Definition at line 104 of file subModelBase.C.
Referenced by CloudFunctionObject< CloudType >::CloudFunctionObject().
const Foam::dictionary & dict | ( | ) | const |
Return const access to the cloud dictionary.
Definition at line 110 of file subModelBase.C.
Referenced by BreakupModel< CloudType >::BreakupModel(), and InjectionModel< CloudType >::InjectionModel().
const Foam::word & baseName | ( | ) | const |
Return const access to the base name of the sub-model.
Definition at line 116 of file subModelBase.C.
const Foam::word & modelType | ( | ) | const |
Return const access to the sub-model type.
Definition at line 122 of file subModelBase.C.
const Foam::dictionary & coeffDict | ( | ) | const |
Return const access to the coefficients dictionary.
Definition at line 128 of file subModelBase.C.
Referenced by CloudFilmTransfer< CloudType >::CloudFilmTransfer(), COxidationHurtMitchell< CloudType >::COxidationHurtMitchell(), ETAB< CloudType >::ETAB(), FacePostProcessing< CloudType >::FacePostProcessing(), LocalInteraction< CloudType >::LocalInteraction(), ParticleCollector< CloudType >::ParticleCollector(), ParticleErosion< CloudType >::ParticleErosion(), PatchInjection< CloudType >::PatchInjection(), PatchPostProcessing< CloudType >::PatchPostProcessing(), PilchErdman< CloudType >::PilchErdman(), ReitzDiwakar< CloudType >::ReitzDiwakar(), ReitzKHRT< CloudType >::ReitzKHRT(), SingleMixtureFraction< CloudType >::SingleMixtureFraction(), and StandardWallInteraction< CloudType >::StandardWallInteraction().
const Foam::dictionary & properties | ( | ) | const |
Return const access to the properties dictionary.
Definition at line 134 of file subModelBase.C.
Referenced by LiquidEvaporation< CloudType >::dh(), and LiquidEvaporationBoil< CloudType >::dh().
|
virtual |
Returns true if defaultCoeffs is true and outputs on printMsg.
Definition at line 140 of file subModelBase.C.
References Foam::decrIndent(), Foam::endl(), Foam::incrIndent(), Foam::indent(), and Foam::Info.
Referenced by ETAB< CloudType >::ETAB(), PilchErdman< CloudType >::PilchErdman(), ReitzDiwakar< CloudType >::ReitzDiwakar(), and ReitzKHRT< CloudType >::ReitzKHRT().
|
virtual |
Cache dependent sub-model fields.
Reimplemented in Implicit< CloudType >, Explicit< CloudType >, Relaxation< CloudType >, GradientDispersionRAS< CloudType >, and DispersionRASModel< CloudType >.
Definition at line 154 of file subModelBase.C.
Referenced by Explicit< CloudType >::cacheFields(), and Implicit< CloudType >::cacheFields().
|
pure virtual |
Flag to indicate when to write a property.
Implemented in CloudSubModelBase< CloudType >.
Type getBaseProperty | ( | const word & | entryName, |
const Type & | defaultValue = pTraits<Type>::zero |
||
) | const |
Retrieve generic property from the base model.
Definition at line 29 of file subModelBaseTemplates.C.
References subModelBase::baseName_, dictionary::found(), subModelBase::properties_, dictionary::readIfPresent(), and dictionary::subDict().
void getBaseProperty | ( | const word & | entryName, |
Type & | value | ||
) | const |
Retrieve generic property from the base model.
Definition at line 48 of file subModelBaseTemplates.C.
References dictionary::readIfPresent(), and dictionary::subDict().
void setBaseProperty | ( | const word & | entryName, |
const Type & | value | ||
) |
Add generic property to the base model.
Definition at line 63 of file subModelBaseTemplates.C.
References dictionary::add(), and dictionary::subDict().
void getModelProperty | ( | const word & | entryName, |
Type & | value | ||
) | const |
Retrieve generic property from the sub-model.
Definition at line 83 of file subModelBaseTemplates.C.
References dictionary::found(), dictionary::readIfPresent(), and dictionary::subDict().
Type getModelProperty | ( | const word & | entryName, |
const Type & | defaultValue = pTraits<Type>::zero |
||
) | const |
Retrieve generic property from the sub-model.
Definition at line 106 of file subModelBaseTemplates.C.
void setModelProperty | ( | const word & | entryName, |
const Type & | value | ||
) |
Add generic property to the sub-model.
Definition at line 119 of file subModelBaseTemplates.C.
References dictionary::add(), dictionary::found(), and dictionary::subDict().
|
virtual |
Write.
Reimplemented in DispersionRASModel< CloudType >, and CloudSubModelBase< CloudType >.
Definition at line 158 of file subModelBase.C.
Referenced by CloudSubModelBase< CloudType >::write().
|
delete |
Disallow default bitwise assignment.
|
protected |
Name of the sub-model.
Definition at line 59 of file subModelBase.H.
|
protected |
Reference to properties dictionary e.g. for restart.
Definition at line 62 of file subModelBase.H.
Referenced by subModelBase::getBaseProperty().
|
protected |
Copy of dictionary used during construction.
Definition at line 65 of file subModelBase.H.
|
protected |
Name of the sub-model base class.
Definition at line 68 of file subModelBase.H.
Referenced by subModelBase::getBaseProperty().
|
protected |
Type of the sub-model.
Definition at line 71 of file subModelBase.H.
|
protected |
Coefficients dictionary.
Definition at line 74 of file subModelBase.H.