Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
subModelBase Class Reference

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...

Inheritance diagram for subModelBase:
Inheritance graph
[legend]
Collaboration diagram for subModelBase:
Collaboration graph
[legend]

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 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...
 
virtual bool outputTime () const
 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...
 

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...
 
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

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.

Base class for surface film sub-models.

Source files

Source files

Definition at line 51 of file subModelBase.H.

Constructor & Destructor Documentation

subModelBase ( dictionary properties)

Construct null.

Definition at line 38 of file subModelBase.C.

Referenced by subModelBase::subModelBase().

Here is the caller graph for this function:

subModelBase ( dictionary properties,
const dictionary dict,
const word baseName,
const word modelType,
const word dictExt = "Coeffs" 
)

Construct from components without name.

Definition at line 50 of file subModelBase.C.

References subModelBase::subModelBase().

Here is the call graph for this function:

subModelBase ( const word modelName,
dictionary properties,
const dictionary dict,
const word baseName,
const word modelType 
)

Construct from components with name.

Definition at line 68 of file subModelBase.C.

subModelBase ( const subModelBase smb)

Construct as copy.

Definition at line 85 of file subModelBase.C.

~subModelBase ( )
virtual

Destructor.

Definition at line 98 of file subModelBase.C.

Member Function Documentation

bool inLine ( ) const
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.

References subModelBase::modelName_.

Referenced by CloudFunctionObject< CloudType >::CloudFunctionObject(), and InjectionModel< CloudType >::info().

Here is the caller graph for this function:

const Foam::dictionary & dict ( ) const

Return const access to the cloud dictionary.

Definition at line 110 of file subModelBase.C.

References subModelBase::dict_.

Referenced by IsotropyModel< CloudType >::New(), DampingModel< CloudType >::New(), PackingModel< CloudType >::New(), and constantFilmThermo::thermoData::thermoData().

Here is the caller graph for this function:

const Foam::word & baseName ( ) const

Return const access to the base name of the sub-model.

Definition at line 116 of file subModelBase.C.

References subModelBase::baseName_.

const Foam::word & modelType ( ) const

Return const access to the sub-model type.

Definition at line 122 of file subModelBase.C.

References subModelBase::modelType_.

Referenced by filmSubModelBase::filmType(), IsotropyModel< CloudType >::New(), DampingModel< CloudType >::New(), and PackingModel< CloudType >::New().

Here is the caller graph for this function:

const Foam::dictionary & coeffDict ( ) const

Return const access to the coefficients dictionary.

Definition at line 128 of file subModelBase.C.

References subModelBase::coeffDict_.

Referenced by InjectionModel< CloudType >::InjectionModel().

Here is the caller graph for this function:

const Foam::dictionary & properties ( ) const

Return const access to the properties dictionary.

Definition at line 134 of file subModelBase.C.

References subModelBase::properties_.

Referenced by LiquidEvaporation< CloudType >::dh(), and LiquidEvaporationBoil< CloudType >::dh().

Here is the caller graph for this function:

bool defaultCoeffs ( const bool  printMsg) const
virtual

Returns true if defaultCoeffs is true and outputs on printMsg.

Definition at line 140 of file subModelBase.C.

References subModelBase::coeffDict_, Foam::decrIndent(), Foam::endl(), Foam::incrIndent(), Foam::indent(), Foam::Info, and dictionary::lookupOrDefault().

Here is the call graph for this function:

bool active ( ) const
virtual
void cacheFields ( const bool  store)
virtual
bool outputTime ( ) const
virtual
Type getBaseProperty ( const word entryName,
const Type &  defaultValue = pTraits<Type>::zero 
) const

Retrieve generic property from the base model.

Definition at line 30 of file subModelBaseTemplates.C.

References dictionary::readIfPresent(), and dictionary::subDict().

Referenced by injectionModelList::info().

Here is the call graph for this function:

Here is the caller graph for this function:

void getBaseProperty ( const word entryName,
Type &  value 
) const

Retrieve generic property from the base model.

Definition at line 49 of file subModelBaseTemplates.C.

References dictionary::readIfPresent(), subModelBase::setBaseProperty(), and dictionary::subDict().

Here is the call graph for this function:

void setBaseProperty ( const word entryName,
const Type &  value 
)

Add generic property to the base model.

Definition at line 64 of file subModelBaseTemplates.C.

References dictionary::add(), subModelBase::getModelProperty(), and dictionary::subDict().

Referenced by subModelBase::getBaseProperty(), and injectionModelList::info().

Here is the call graph for this function:

Here is the caller graph for this function:

void getModelProperty ( const word entryName,
Type &  value 
) const

Retrieve generic property from the sub-model.

Definition at line 84 of file subModelBaseTemplates.C.

References dictionary::found(), dictionary::readIfPresent(), and dictionary::subDict().

Referenced by subModelBase::setBaseProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

Type getModelProperty ( const word entryName,
const Type &  defaultValue = pTraits<Type>::zero 
) const

Retrieve generic property from the sub-model.

Definition at line 107 of file subModelBaseTemplates.C.

References subModelBase::setModelProperty().

Here is the call graph for this function:

void setModelProperty ( const word entryName,
const Type &  value 
)

Add generic property to the sub-model.

Definition at line 120 of file subModelBaseTemplates.C.

References dictionary::add(), dictionary::found(), and dictionary::subDict().

Referenced by subModelBase::getModelProperty(), SurfaceFilmModel< CloudType >::info(), and InjectionModel< CloudType >::info().

Here is the call graph for this function:

Here is the caller graph for this function:

void write ( Ostream os) const
virtual

Member Data Documentation

const word modelName_
protected

Name of the sub-model.

Definition at line 64 of file subModelBase.H.

Referenced by subModelBase::modelName().

dictionary& properties_
protected

Reference to properties dictionary e.g. for restart.

Definition at line 67 of file subModelBase.H.

Referenced by subModelBase::properties().

const dictionary dict_
protected

Copy of dictionary used during construction.

Definition at line 70 of file subModelBase.H.

Referenced by subModelBase::dict().

const word baseName_
protected

Name of the sub-model base class.

Definition at line 73 of file subModelBase.H.

Referenced by subModelBase::baseName().

const word modelType_
protected

Type of the sub-model.

Definition at line 76 of file subModelBase.H.

Referenced by subModelBase::modelType().

const dictionary coeffDict_
protected

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