Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | 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 Types

enum  frictionMethodType { mquadraticProfile, mlinearProfile, mDarcyWeisbach, mManningStrickler }
 
enum  shearMethodType { msimple, mwallFunction }
 

Public Member Functions

 TypeName ("filmTurbulenceModel")
 
 declareRunTimeSelectionTable (autoPtr, filmTurbulenceModel, dictionary,(liquidFilmBase &film, const dictionary &dict),(film, dict))
 
 filmTurbulenceModel (const word &modelType, liquidFilmBase &film, const dictionary &dict)
 
virtual ~filmTurbulenceModel ()=default
 
const liquidFilmBase & film () const
 
tmp< volSymmTensorField > devRhoReff () const
 
tmp< faVectorMatrix > primaryRegionFriction (areaVectorField &U) const
 
tmp< volScalarField > rho () const
 
virtual tmp< areaScalarField > Cw () const
 
virtual tmp< areaScalarField > mut () const =0
 
virtual void correct ()=0
 
virtual tmp< faVectorMatrix > Su (areaVectorField &U) const =0
 

Static Public Member Functions

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

Protected Attributes

const liquidFilmBase & film_
 
const dictionary dict_
 
const frictionMethodType method_
 
const shearMethodType shearMethod_
 
word rhoName_
 
scalar rhoRef_
 

Static Protected Attributes

static const Enum< frictionMethodType > frictionMethodTypeNames_
 
static const Enum< shearMethodType > shearMethodTypeNames_
 

Detailed Description

Base class for film turbulence models.

Source files

Definition at line 56 of file filmTurbulenceModel.H.

Member Enumeration Documentation

◆ frictionMethodType

enum frictionMethodType
Enumerator
mquadraticProfile 
mlinearProfile 
mDarcyWeisbach 
mManningStrickler 

Definition at line 72 of file filmTurbulenceModel.H.

◆ shearMethodType

enum shearMethodType
Enumerator
msimple 
mwallFunction 

Definition at line 81 of file filmTurbulenceModel.H.

Constructor & Destructor Documentation

◆ filmTurbulenceModel()

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

Definition at line 67 of file filmTurbulenceModel.C.

References Enum::get().

Here is the call graph for this function:

◆ ~filmTurbulenceModel()

virtual ~filmTurbulenceModel ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "filmTurbulenceModel"  )

◆ declareRunTimeSelectionTable()

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

◆ New()

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

Definition at line 35 of file filmTurbulenceModelNew.C.

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

Here is the call graph for this function:

◆ film()

const liquidFilmBase & film ( ) const

Definition at line 89 of file filmTurbulenceModel.C.

References filmTurbulenceModel::film_.

Referenced by laminar::mut().

Here is the caller graph for this function:

◆ devRhoReff()

tmp< Foam::volSymmTensorField > devRhoReff ( ) const

Definition at line 268 of file filmTurbulenceModel.C.

References Foam::dev(), basicThermo::dictName, Foam::dimViscosity, Foam::exit(), Foam::FatalError, FatalErrorInFunction, filmTurbulenceModel::film_, objectRegistry::foundObject(), Foam::fvc::grad(), objectRegistry::lookupObject(), nu, GeometricField::null(), regionFaModel::primaryMesh(), filmTurbulenceModel::rho(), transportProperties(), turb, Foam::twoSymm(), U, and liquidFilmBase::UName().

Here is the call graph for this function:

◆ primaryRegionFriction()

tmp< faVectorMatrix > primaryRegionFriction ( areaVectorField &  U) const

Definition at line 186 of file filmTurbulenceModel.C.

References Foam::dimLength, Foam::dimVelocity, tmp::New(), tmp::ref(), Foam::fam::Sp(), Foam::sqr(), U, and Foam::Zero.

Referenced by laminar::Su().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ rho()

tmp< Foam::volScalarField > rho ( ) const

Definition at line 325 of file filmTurbulenceModel.C.

References Foam::dimDensity, filmTurbulenceModel::film_, objectRegistry::lookupObject(), tmp::New(), regionFaModel::primaryMesh(), filmTurbulenceModel::rhoName_, filmTurbulenceModel::rhoRef_, fvMesh::time(), and Time::timeName().

Referenced by filmTurbulenceModel::Cw(), and filmTurbulenceModel::devRhoReff().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Cw()

tmp< areaScalarField > Cw ( ) const
virtual

Definition at line 95 of file filmTurbulenceModel.C.

References Foam::cbrt(), filmTurbulenceModel::dict_, Foam::dimVelocity, Foam::exit(), Foam::FatalError, FatalErrorInFunction, filmTurbulenceModel::film_, Foam::flatOutput(), filmTurbulenceModel::frictionMethodTypeNames_, g, dictionary::get(), Foam::constant::universal::h, liquidFilmBase::h(), h0, liquidFilmBase::h0(), Foam::mag(), filmTurbulenceModel::mDarcyWeisbach, filmTurbulenceModel::method_, filmTurbulenceModel::mlinearProfile, filmTurbulenceModel::mManningStrickler, filmTurbulenceModel::mquadraticProfile, Foam::constant::physicoChemical::mu, liquidFilmBase::mu(), n, gravity::New(), tmp::New(), Foam::nl, regionFaModel::primaryMesh(), GeometricField::primitiveField(), regionFaModel::regionMesh(), filmTurbulenceModel::rho(), liquidFilmBase::rho(), Enum::sortedToc(), Foam::sqr(), fvMesh::time(), Time::timeName(), Uf, liquidFilmBase::Uf(), and dimensioned::value().

Referenced by laminar::wallFriction().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ mut()

virtual tmp<areaScalarField> mut ( ) const
pure virtual

Implemented in laminar.

◆ correct()

virtual void correct ( )
pure virtual

Implemented in laminar.

◆ Su()

virtual tmp<faVectorMatrix> Su ( areaVectorField &  U) const
pure virtual

Implemented in laminar.

Member Data Documentation

◆ film_

const liquidFilmBase& film_
protected

Definition at line 93 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel::Cw(), filmTurbulenceModel::devRhoReff(), filmTurbulenceModel::film(), filmTurbulenceModel::rho(), and laminar::wallFriction().

◆ frictionMethodTypeNames_

const Enum< filmTurbulenceModel::frictionMethodType > frictionMethodTypeNames_
staticprotected
Initial value:
{
{ frictionMethodType::mquadraticProfile, "quadraticProfile" },
{ frictionMethodType::mlinearProfile, "linearProfile" },
{ frictionMethodType::mDarcyWeisbach, "DarcyWeisbach" },
{ frictionMethodType::mManningStrickler, "ManningStrickler" }
}

Definition at line 96 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel::Cw().

◆ shearMethodTypeNames_

const Enum< filmTurbulenceModel::shearMethodType > shearMethodTypeNames_
staticprotected
Initial value:
{
{ shearMethodType::msimple, "simple" },
{ shearMethodType::mwallFunction, "wallFunction" }
}

Definition at line 99 of file filmTurbulenceModel.H.

◆ dict_

const dictionary dict_
protected

Definition at line 102 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel::Cw().

◆ method_

const frictionMethodType method_
protected

Definition at line 105 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel::Cw().

◆ shearMethod_

const shearMethodType shearMethod_
protected

Definition at line 108 of file filmTurbulenceModel.H.

◆ rhoName_

word rhoName_
protected

Definition at line 111 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel::rho().

◆ rhoRef_

scalar rhoRef_
protected

Definition at line 114 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel::rho().

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17