Base class for film turbulence models. More...
Public Member Functions | |
TypeName ("filmTurbulenceModel") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, filmTurbulenceModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict)) | |
filmTurbulenceModel (surfaceFilmRegionModel &film) | |
Construct null. More... | |
filmTurbulenceModel (const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict) | |
Construct from type name, dictionary and surface film model. More... | |
virtual | ~filmTurbulenceModel () |
Destructor. More... | |
virtual tmp< volVectorField > | Us () const =0 |
Return the film surface velocity. More... | |
virtual tmp< volScalarField > | mut () const =0 |
Return the film turbulence viscosity. More... | |
virtual void | correct ()=0 |
Correct/update the model. More... | |
virtual tmp< fvVectorMatrix > | Su (volVectorField &U) const =0 |
Return the source for the film momentum equation. More... | |
Public Member Functions inherited from filmSubModelBase | |
filmSubModelBase (surfaceFilmRegionModel &film) | |
Construct null. More... | |
filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs") | |
Construct from film film without name. More... | |
filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType) | |
Construct from film film with name. More... | |
virtual | ~filmSubModelBase () |
Destructor. More... | |
virtual bool | writeTime () const |
Flag to indicate when to write a property. More... | |
const surfaceFilmRegionModel & | film () const |
Return const access to the film surface film model. More... | |
surfaceFilmRegionModel & | film () |
Return the reference to the film surface film model. More... | |
template<class FilmType > | |
const FilmType & | filmType () const |
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 ()=default |
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 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 > | |
bool | 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... | |
Static Public Member Functions | |
static autoPtr< filmTurbulenceModel > | New (surfaceFilmRegionModel &film, const dictionary &dict) |
Return a reference to the selected injection model. More... | |
Additional Inherited Members | |
Public Attributes inherited from subModelBase | |
bool | log |
Flag to write log into Info. 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 filmSubModelBase | |
surfaceFilmRegionModel & | filmModel_ |
Reference to the film surface film model. 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... | |
Base class for film turbulence models.
Definition at line 54 of file filmTurbulenceModel.H.
filmTurbulenceModel | ( | surfaceFilmRegionModel & | film | ) |
Construct null.
Definition at line 39 of file filmTurbulenceModel.C.
filmTurbulenceModel | ( | const word & | modelType, |
surfaceFilmRegionModel & | film, | ||
const dictionary & | dict | ||
) |
Construct from type name, dictionary and surface film model.
Definition at line 46 of file filmTurbulenceModel.C.
|
virtual |
Destructor.
Definition at line 58 of file filmTurbulenceModel.C.
TypeName | ( | "filmTurbulenceModel" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
filmTurbulenceModel | , | ||
dictionary | , | ||
(surfaceFilmRegionModel &film, const dictionary &dict) | , | ||
(film, dict) | |||
) |
|
static |
Return a reference to the selected injection model.
Definition at line 36 of file filmTurbulenceModelNew.C.
References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::Info.
|
pure virtual |
Return the film surface velocity.
Implemented in laminar.
|
pure virtual |
Return the film turbulence viscosity.
Implemented in laminar.
|
pure virtual |
Correct/update the model.
Implemented in laminar.
|
pure virtual |
Return the source for the film momentum equation.
Implemented in laminar.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.