Public Member Functions | Static Public Member Functions | List of all members
filmTurbulenceModel Class Referenceabstract

Base class for film turbulence models. More...

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

Public Member Functions

 TypeName ("filmTurbulenceModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, filmTurbulenceModel, dictionary,( surfaceFilmModel &owner, const dictionary &dict ),(owner, dict))
 
 filmTurbulenceModel (surfaceFilmModel &owner)
 Construct null. More...
 
 filmTurbulenceModel (const word &modelType, surfaceFilmModel &owner, const dictionary &dict)
 Construct from type name, dictionary and surface film model. More...
 
virtual ~filmTurbulenceModel ()
 Destructor. More...
 
virtual tmp< volVectorFieldUs () const =0
 Return the film surface velocity. More...
 
virtual tmp< volScalarFieldmut () const =0
 Return the film turbulence viscosity. More...
 
virtual void correct ()=0
 Correct/update the model. More...
 
virtual tmp< fvVectorMatrixSu (volVectorField &U) const =0
 Return the source for the film momentum equation. More...
 
- Public Member Functions inherited from filmSubModelBase
 filmSubModelBase (surfaceFilmModel &owner)
 Construct null. More...
 
 filmSubModelBase (surfaceFilmModel &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from owner film wihout name. More...
 
 filmSubModelBase (const word &modelName, surfaceFilmModel &owner, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from owner film with name. More...
 
virtual ~filmSubModelBase ()
 Destructor. More...
 
virtual bool outputTime () const
 Flag to indicate when to write a property. More...
 
const surfaceFilmModelowner () const
 Return const access to the owner surface film model. More...
 
surfaceFilmModelowner ()
 Return the reference to the owner 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 ()
 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...
 
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...
 

Static Public Member Functions

static autoPtr< filmTurbulenceModelNew (surfaceFilmModel &owner, const dictionary &dict)
 Return a reference to the selected injection model. More...
 

Additional Inherited Members

- 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
surfaceFilmModelowner_
 Reference to the owner surface film model. More...
 
- Protected Attributes inherited from subModelBase
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 film turbulence models.

Source files

Definition at line 56 of file filmTurbulenceModel.H.

Constructor & Destructor Documentation

Construct null.

Definition at line 44 of file filmTurbulenceModel.C.

filmTurbulenceModel ( const word modelType,
surfaceFilmModel owner,
const dictionary dict 
)

Construct from type name, dictionary and surface film model.

Definition at line 51 of file filmTurbulenceModel.C.

~filmTurbulenceModel ( )
virtual

Destructor.

Definition at line 63 of file filmTurbulenceModel.C.

Member Function Documentation

TypeName ( "filmTurbulenceModel"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
filmTurbulenceModel  ,
dictionary  ,
( surfaceFilmModel &owner, const dictionary &dict ,
(owner, dict  
)
autoPtr< filmTurbulenceModel > New ( surfaceFilmModel owner,
const dictionary dict 
)
static

Return a reference to the selected injection model.

Definition at line 40 of file filmTurbulenceModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), and Foam::nl.

Here is the call graph for this function:

virtual tmp<volVectorField> Us ( ) const
pure virtual

Return the film surface velocity.

Implemented in laminar.

virtual tmp<volScalarField> mut ( ) const
pure virtual

Return the film turbulence viscosity.

Implemented in laminar.

virtual void correct ( )
pure virtual

Correct/update the model.

Implemented in laminar.

virtual tmp<fvVectorMatrix> Su ( volVectorField U) const
pure virtual

Return the source for the film momentum equation.

Implemented in laminar.


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