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) | |
Construct as copy. 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... | |
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 > | |
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=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... | |
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 54 of file subModelBase.H.
subModelBase | ( | dictionary & | properties | ) |
Construct null.
Definition at line 41 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 53 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 71 of file subModelBase.C.
subModelBase | ( | const subModelBase & | smb | ) |
Construct as copy.
Definition at line 88 of file subModelBase.C.
|
virtual |
Destructor.
Definition at line 101 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 107 of file subModelBase.C.
const Foam::dictionary & dict | ( | ) | const |
Return const access to the cloud dictionary.
Definition at line 113 of file subModelBase.C.
Referenced by liquidFilmThermo::initLiquid().
const Foam::word & baseName | ( | ) | const |
Return const access to the base name of the sub-model.
Definition at line 119 of file subModelBase.C.
const Foam::word & modelType | ( | ) | const |
Return const access to the sub-model type.
Definition at line 125 of file subModelBase.C.
Referenced by filmSubModelBase::filmType().
const Foam::dictionary & coeffDict | ( | ) | const |
Return const access to the coefficients dictionary.
Definition at line 131 of file subModelBase.C.
const Foam::dictionary & properties | ( | ) | const |
Return const access to the properties dictionary.
Definition at line 137 of file subModelBase.C.
Returns true if defaultCoeffs is true and outputs on printMsg.
Definition at line 143 of file subModelBase.C.
References Foam::decrIndent(), Foam::endl(), Foam::incrIndent(), Foam::indent(), and Foam::Info.
|
virtual |
Return the model 'active' status - default active = true.
Reimplemented in NoInjection< CloudType >, and noPhaseChange.
Definition at line 157 of file subModelBase.C.
Referenced by filmSubModelBase::writeTime().
|
virtual |
Cache dependent sub-model fields.
Definition at line 163 of file subModelBase.C.
|
virtual |
Flag to indicate when to write a property.
Reimplemented in CloudSubModelBase< CloudType >, and filmSubModelBase.
Definition at line 167 of file subModelBase.C.
|
virtual |
Output directory.
Reimplemented in CloudSubModelBase< CloudType >.
Definition at line 173 of file subModelBase.C.
References word::null.
Retrieve generic property from the base model.
Definition at line 32 of file subModelBaseTemplates.C.
References dictionary::readIfPresent(), and dictionary::subDict().
Referenced by injectionModelList::info(), and transferModelList::info().
void getBaseProperty | ( | const word & | entryName, |
Type & | value | ||
) | const |
Retrieve generic property from the base model.
Definition at line 51 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 66 of file subModelBaseTemplates.C.
References dictionary::add(), and dictionary::subDict().
Referenced by injectionModelList::info(), and transferModelList::info().
bool getModelDict | ( | const word & | entryName, |
dictionary & | dict | ||
) | const |
Retrieve dictionary, return true if set.
Definition at line 185 of file subModelBase.C.
References dict, dictionary::found(), dictionary::subDict(), and dictionary::subOrEmptyDict().
void getModelProperty | ( | const word & | entryName, |
Type & | value | ||
) | const |
Retrieve generic property from the sub-model.
Definition at line 86 of file subModelBaseTemplates.C.
References dictionary::found(), dictionary::readIfPresent(), and dictionary::subDict().
Retrieve generic property from the sub-model.
Definition at line 109 of file subModelBaseTemplates.C.
void setModelProperty | ( | const word & | entryName, |
const Type & | value | ||
) |
Add generic property to the sub-model.
Definition at line 122 of file subModelBaseTemplates.C.
References dictionary::add(), dictionary::found(), and dictionary::subDict().
|
virtual |
Write.
Reimplemented in CloudSubModelBase< CloudType >.
Definition at line 212 of file subModelBase.C.
Referenced by CloudSubModelBase< CloudType >::write().
|
protected |
Name of the sub-model.
Definition at line 67 of file subModelBase.H.
|
protected |
Reference to properties dictionary e.g. for restart.
Definition at line 70 of file subModelBase.H.
|
protected |
Copy of dictionary used during construction.
Definition at line 73 of file subModelBase.H.
|
protected |
Name of the sub-model base class.
Definition at line 76 of file subModelBase.H.
|
protected |
Type of the sub-model.
Definition at line 79 of file subModelBase.H.
|
protected |
Coefficients dictionary.
Definition at line 82 of file subModelBase.H.
Referenced by constantFilmThermo::Tb(), and constantFilmThermo::W().