laminar Class Reference

Film laminar turbulence model. More...

Inheritance diagram for laminar:
Collaboration diagram for laminar:

Public Member Functions

 TypeName ("laminar")
 Runtime type information. More...
 
 laminar (surfaceFilmRegionModel &film, const dictionary &dict)
 Construct from surface film model. More...
 
 laminar (const laminar &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~laminar ()
 Destructor. More...
 
virtual tmp< volVectorFieldUs () const
 Return the film surface velocity. More...
 
virtual tmp< volScalarFieldmut () const
 Return the film turbulence viscosity. More...
 
virtual void correct ()
 Correct/update the model. More...
 
virtual tmp< fvVectorMatrixSu (volVectorField &U) const
 Return the source for the film momentum equation. More...
 
void operator= (const laminar &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from filmTurbulenceModel
 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...
 
 filmTurbulenceModel (const filmTurbulenceModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~filmTurbulenceModel ()
 Destructor. More...
 
void operator= (const filmTurbulenceModel &)=delete
 Disallow default bitwise assignment. 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 surfaceFilmRegionModelfilm () const
 Return const access to the film surface film model. More...
 
surfaceFilmRegionModelfilm ()
 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)
 Copy constructor. 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 dependent 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...
 
void operator= (const subModelBase &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from filmTurbulenceModel
static autoPtr< filmTurbulenceModelNew (surfaceFilmRegionModel &film, const dictionary &dict)
 Return a reference to the selected injection model. 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
surfaceFilmRegionModelfilmModel_
 Reference to the film 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

Film laminar turbulence model.

Source files

Definition at line 52 of file laminar.H.

Constructor & Destructor Documentation

◆ laminar() [1/2]

laminar ( surfaceFilmRegionModel film,
const dictionary dict 
)

Construct from surface film model.

Definition at line 53 of file laminar.C.

◆ laminar() [2/2]

laminar ( const laminar )
delete

Disallow default bitwise copy construction.

◆ ~laminar()

~laminar ( )
virtual

Destructor.

Definition at line 65 of file laminar.C.

Member Function Documentation

◆ TypeName()

TypeName ( "laminar"  )

Runtime type information.

◆ Us()

tmp< volVectorField > Us ( ) const
virtual

Return the film surface velocity.

Implements filmTurbulenceModel.

Definition at line 71 of file laminar.C.

References Foam::dimVelocity, filmSubModelBase::filmModel_, GeometricField< vector, fvPatchField, volMesh >::New(), tmp< T >::ref(), regionModel::regionMesh(), Foam::sqrt(), surfaceFilmRegionModel::U(), and Foam::Zero.

Here is the call graph for this function:

◆ mut()

tmp< volScalarField > mut ( ) const
virtual

Return the film turbulence viscosity.

Implements filmTurbulenceModel.

Definition at line 92 of file laminar.C.

References Foam::dimLength, Foam::dimMass, Foam::dimTime, filmSubModelBase::filmModel_, GeometricField< scalar, fvPatchField, volMesh >::New(), and regionModel::regionMesh().

Here is the call graph for this function:

◆ correct()

void correct ( )
virtual

Correct/update the model.

Implements filmTurbulenceModel.

Definition at line 106 of file laminar.C.

◆ Su()

◆ operator=()

void operator= ( const laminar )
delete

Disallow default bitwise assignment.


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