filmTurbulenceModel Class Reference

Base class for film turbulence models. More...

Inheritance diagram for filmTurbulenceModel:

Collaboration diagram for filmTurbulenceModel:

Public Member Functions
	TypeName ("filmTurbulenceModel")
	declareRunTimeSelectionTable (autoPtr, filmTurbulenceModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict))
	filmTurbulenceModel (surfaceFilmRegionModel &film)
	filmTurbulenceModel (const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict)
virtual	~filmTurbulenceModel ()
virtual tmp< volVectorField >	Us () const =0
virtual tmp< volScalarField >	mut () const =0
virtual void	correct ()=0
virtual tmp< fvVectorMatrix >	Su (volVectorField &U) const =0
Public Member Functions inherited from filmSubModelBase
	filmSubModelBase (surfaceFilmRegionModel &film)
	filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
virtual	~filmSubModelBase ()
virtual bool	writeTime () const
const surfaceFilmRegionModel &	film () const
surfaceFilmRegionModel &	film ()
template<class FilmType >
const FilmType &	filmType () const
Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	subModelBase (const subModelBase &smb)
virtual	~subModelBase ()
const word &	modelName () const
const dictionary &	dict () const
const word &	baseName () const
const word &	modelType () const
const dictionary &	coeffDict () const
const dictionary &	properties () const
virtual bool	defaultCoeffs (const bool printMsg) const
virtual bool	active () const
virtual void	cacheFields (const bool store)
virtual fileName	localPath () const
template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const
template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)
bool	getModelDict (const word &entryName, dictionary &dict) const
template<class Type >
void	getModelProperty (const word &entryName, Type &value) const
template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
void	setModelProperty (const word &entryName, const Type &value)
virtual void	write (Ostream &os) const

Static Public Member Functions
static autoPtr< filmTurbulenceModel >	New (surfaceFilmRegionModel &film, const dictionary &dict)

Additional Inherited Members
Protected Member Functions inherited from subModelBase
bool	inLine () const
Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModel &	filmModel_
Protected Attributes inherited from subModelBase
const word	modelName_
dictionary &	properties_
const dictionary	dict_
const word	baseName_
const word	modelType_
const dictionary	coeffDict_

Detailed Description

Base class for film turbulence models.

Source files

• filmTurbulenceModel.H
• filmTurbulenceModel.C
• filmTurbulenceModelNew.C

Definition at line 54 of file filmTurbulenceModel.H.

Constructor & Destructor Documentation

filmTurbulenceModel() [1/2]

filmTurbulenceModel

(

surfaceFilmRegionModel &

film

)

Definition at line 39 of file filmTurbulenceModel.C.

filmTurbulenceModel() [2/2]

filmTurbulenceModel	(	const word &	modelType,
		surfaceFilmRegionModel &	film,
		const dictionary &	dict
	)

Definition at line 46 of file filmTurbulenceModel.C.

~filmTurbulenceModel()

~filmTurbulenceModel ( )

virtual

Definition at line 58 of file filmTurbulenceModel.C.

Member Function Documentation

TypeName()

TypeName

(

"filmTurbulenceModel"

)

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		filmTurbulenceModel	,
		dictionary	,
		(surfaceFilmRegionModel &film, const dictionary &dict)	,
		(film, dict)
	)

New()

autoPtr< filmTurbulenceModel > New ( surfaceFilmRegionModel &  film, const dictionary &  dict  )

static

Definition at line 36 of file filmTurbulenceModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::Info.

Here is the call graph for this function:

Us()

virtual tmp<volVectorField> Us ( ) const

pure virtual

Implemented in laminar.

mut()

virtual tmp<volScalarField> mut ( ) const

pure virtual

Implemented in laminar.

correct()

virtual void correct ( )

pure virtual

Implemented in laminar.

Su()

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

pure virtual

Implemented in laminar.

---

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

• src/regionModels/surfaceFilmModels/submodels/kinematic/filmTurbulenceModel/filmTurbulenceModel/filmTurbulenceModel.H
• src/regionModels/surfaceFilmModels/submodels/kinematic/filmTurbulenceModel/filmTurbulenceModel/filmTurbulenceModel.C
• src/regionModels/surfaceFilmModels/submodels/kinematic/filmTurbulenceModel/filmTurbulenceModel/filmTurbulenceModelNew.C