Base class for film turbulence models. More...

#include <filmTurbulenceModel.H>

Inheritance diagram for filmTurbulenceModel:

Collaboration diagram for filmTurbulenceModel:

[legend]

Public Types
enum	frictionMethodType { mquadraticProfile , mlinearProfile , mDarcyWeisbach , mManningStrickler }
	Options for the friction models. More...
enum	shearMethodType { msimple , mwallFunction }
	Options for the shear stress models. More...

Public Member Functions
	TypeName ("filmTurbulenceModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, filmTurbulenceModel, dictionary,(liquidFilmBase &film, const dictionary &dict),(film, dict))
	filmTurbulenceModel (const word &modelType, liquidFilmBase &film, const dictionary &dict)
	Construct from type name, dictionary and surface film model.
virtual	~filmTurbulenceModel ()=default
	Destructor.
const liquidFilmBase &	film () const
	Return film.
tmp< volSymmTensorField >	devRhoReff () const
	Return the effective viscous stress (laminar + turbulent).
tmp< faVectorMatrix >	primaryRegionFriction (areaVectorField &U) const
	Return primary region friction.
tmp< volScalarField >	rho () const
	Return rho if specified otherwise rhoRef.
virtual tmp< areaScalarField >	Cw () const
	Return the wall film surface friction.
virtual tmp< areaScalarField >	mut () const =0
	Return the film turbulence viscosity.
virtual void	correct ()=0
	Correct/update the model.
virtual tmp< faVectorMatrix >	Su (areaVectorField &U) const =0
	Return the source for the film momentum equation.

Static Public Member Functions
static autoPtr< filmTurbulenceModel >	New (liquidFilmBase &film, const dictionary &dict)
	Return a reference to the selected injection model.

Protected Attributes
const liquidFilmBase &	film_
	Reference to liquidFilmBase.
const dictionary	dict_
	Model dictionary.
const frictionMethodType	method_
	Friction model.
const shearMethodType	shearMethod_
	Shear-stress model.
word	rhoName_
	Name of density field.
scalar	rhoRef_
	Reference density needed for incompressible calculations.
autoPtr< areaScalarField >	CwPtr_
	Wall film-surface friction field.
autoPtr< areaScalarField >	dwfPtr_
	Darcy-Weisbach model field.

Static Protected Attributes
static const Enum< frictionMethodType >	frictionMethodTypeNames_
	Names for friction models.
static const Enum< shearMethodType >	shearMethodTypeNames_
	Names for shear stress models.

Detailed Description

Base class for film turbulence models.

Usage

Example of the model specification:

{
    // Mandatory entries
    turbulence          <model>;

    <model>Coeffs
    {
        // Mandatory entries
        friction        <word>;
        shearStress     <word>;

        // Optional entries
        rho             <word>;

        // Conditional entries

            // if rho=rhoInf
            rhoInf          <scalar>;

            // if friction=DarcyWeisbach
            DarcyWeisbach   <scalar>;

            // if friction=ManningStrickler
            n               <scalar>;

            // if shearStress=simple
            Cf              <scalar>;
    }

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`turbulence`	Model name	word	yes	-
`friction`	Friction model	word	yes	-
`shearStress`	Shear-stress model	word	yes	-
`rho`	Name of density field	word	no	rho
`rhoInf`	Reference density	scalar	choice	-
`DarcyWeisbach`	Friction-model constant	scalar	choice	-
`n`	Friction-model constant	scalar	choice	-
`Cf`	Skin-friction coefficient	scalar	choice	-

Options for the friction entry:

      quadraticProfile    | Quadratic-profile model
      linearProfile       | Linear-profile model
      DarcyWeisbach       | Darcy-Weisbach model
      ManningStrickler    | Manning-Strickler model

Options for the shearStress entry:

      simple              | Skin-friction coefficient model
      wallFunction        | Wall-function model

Source files

Definition at line 169 of file filmTurbulenceModel.H.

Member Enumeration Documentation

◆ frictionMethodType

enum frictionMethodType

Options for the friction models.

Enumerator
mquadraticProfile
mlinearProfile
mDarcyWeisbach
mManningStrickler

Definition at line 191 of file filmTurbulenceModel.H.

◆ shearMethodType

enum shearMethodType

Options for the shear stress models.

Enumerator
msimple
mwallFunction

Definition at line 202 of file filmTurbulenceModel.H.

Constructor & Destructor Documentation

◆ filmTurbulenceModel()

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

Construct from type name, dictionary and surface film model.

Definition at line 66 of file filmTurbulenceModel.C.

References IOobjectOption::AUTO_WRITE, CwPtr_, dict, dict_, Foam::dimVelocity, dwfPtr_, film(), film_, frictionMethodTypeNames_, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, method_, IOobjectOption::MUST_READ, IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, rhoName_, rhoRef_, IOobject::scopedName(), shearMethod_, shearMethodTypeNames_, and Foam::Zero.

Here is the call graph for this function:

◆ ~filmTurbulenceModel()

virtual ~filmTurbulenceModel ( )

virtualdefault

Destructor.

References U.

Member Function Documentation

◆ TypeName()

TypeName ( "filmTurbulenceModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

References dict, and film().

Here is the call graph for this function:

◆ New()

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

static

Return a reference to the selected injection model.

Definition at line 34 of file filmTurbulenceModelNew.C.

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

Here is the call graph for this function:

◆ film()

const liquidFilmBase & film ( ) const

Return film.

Definition at line 130 of file filmTurbulenceModel.C.

References film_.

Referenced by declareRunTimeSelectionTable(), filmTurbulenceModel(), laminar::laminar(), laminar::mut(), and laminar::TypeName().

Here is the caller graph for this function:

◆ devRhoReff()

tmp< Foam::volSymmTensorField > devRhoReff ( ) const

Return the effective viscous stress (laminar + turbulent).

Definition at line 328 of file filmTurbulenceModel.C.

References Foam::devTwoSymm(), basicThermo::dictName, Foam::dimViscosity, Foam::exit(), Foam::FatalError, FatalErrorInFunction, film_, objectRegistry::foundObject(), Foam::fvc::grad(), objectRegistry::lookupObject(), transportModel::nu(), nu, rho(), transportProperties(), turb, and U.

Referenced by primaryRegionFriction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ primaryRegionFriction()

tmp< faVectorMatrix > primaryRegionFriction ( areaVectorField & U ) const

Return primary region friction.

Definition at line 224 of file filmTurbulenceModel.C.

References devRhoReff(), dict_, Foam::dimLength, Foam::dimVelocity, film_, UList< T >::first(), forAll, HashPtrTable< T, Key, Hash >::get(), msimple, mwallFunction, GeometricField< vector, faPatchField, areaMesh >::New(), tmp< T >::New(), IOobjectOption::NO_REGISTER, patchIds, HashPtrTable< T, Key, Hash >::set(), shearMethod_, UList< T >::size(), 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

Return rho if specified otherwise rhoRef.

Definition at line 385 of file filmTurbulenceModel.C.

References Foam::dimDensity, film_, mesh, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, rhoName_, and rhoRef_.

Referenced by Cw(), and devRhoReff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Cw()

tmp< areaScalarField > Cw ( ) const

virtual

Return the wall film surface friction.

Definition at line 136 of file filmTurbulenceModel.C.

References Foam::cbrt(), Cw(), CwPtr_, dict_, dwfPtr_, Foam::exit(), Foam::FatalError, FatalErrorInFunction, film_, Foam::flatOutput(), frictionMethodTypeNames_, g, h, h0, Foam::mag(), mDarcyWeisbach, method_, mlinearProfile, mManningStrickler, mquadraticProfile, mu, n, gravity::New(), Foam::nl, rho(), Foam::sqr(), and Uf.

Referenced by Cw(), and 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

Return the film turbulence viscosity.

Implemented in laminar.

◆ correct()

virtual void correct ( )

pure virtual

Correct/update the model.

Implemented in laminar.

◆ Su()

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

pure virtual

Return the source for the film momentum equation.

Implemented in laminar.

References U.

Member Data Documentation

◆ film_

const liquidFilmBase& film_

protected

Reference to liquidFilmBase.

Definition at line 216 of file filmTurbulenceModel.H.

Referenced by Cw(), devRhoReff(), film(), filmTurbulenceModel(), primaryRegionFriction(), 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" }
}

Names for friction models.

Definition at line 221 of file filmTurbulenceModel.H.

Referenced by Cw(), Foam::regionModels::areaSurfaceFilmModels::defineRunTimeSelectionTable(), and filmTurbulenceModel().

◆ shearMethodTypeNames_

const Enum< filmTurbulenceModel::shearMethodType > shearMethodTypeNames_

staticprotected

Initial value:

{
    { shearMethodType::msimple, "simple" },
    { shearMethodType::mwallFunction, "wallFunction" }
}

Names for shear stress models.

Definition at line 226 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel().

◆ dict_

const dictionary dict_

protected

Model dictionary.

Definition at line 231 of file filmTurbulenceModel.H.

Referenced by Cw(), filmTurbulenceModel(), and primaryRegionFriction().

◆ method_

const frictionMethodType method_

protected

Friction model.

Definition at line 236 of file filmTurbulenceModel.H.

Referenced by Cw(), and filmTurbulenceModel().

◆ shearMethod_

const shearMethodType shearMethod_

protected

Shear-stress model.

Definition at line 241 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel(), and primaryRegionFriction().

◆ rhoName_

word rhoName_

protected

Name of density field.

Definition at line 246 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel(), and rho().

◆ rhoRef_

scalar rhoRef_

protected

Reference density needed for incompressible calculations.

Definition at line 251 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel(), and rho().

◆ CwPtr_

autoPtr<areaScalarField> CwPtr_

mutableprotected

Wall film-surface friction field.

Definition at line 256 of file filmTurbulenceModel.H.

Referenced by Cw(), and filmTurbulenceModel().

◆ dwfPtr_

autoPtr<areaScalarField> dwfPtr_

mutableprotected

Darcy-Weisbach model field.

Definition at line 261 of file filmTurbulenceModel.H.

Referenced by Cw(), and filmTurbulenceModel().

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

src/regionFaModels/liquidFilm/subModels/kinematic/filmTurbulenceModel/filmTurbulenceModel/filmTurbulenceModel.H
src/regionFaModels/liquidFilm/subModels/kinematic/filmTurbulenceModel/filmTurbulenceModel/filmTurbulenceModel.C
src/regionFaModels/liquidFilm/subModels/kinematic/filmTurbulenceModel/filmTurbulenceModel/filmTurbulenceModelNew.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ frictionMethodType

◆ shearMethodType

Constructor & Destructor Documentation

◆ filmTurbulenceModel()

◆ ~filmTurbulenceModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ film()

◆ devRhoReff()

◆ primaryRegionFriction()

◆ rho()

◆ Cw()

◆ mut()

◆ correct()

◆ Su()

Member Data Documentation

◆ film_

◆ frictionMethodTypeNames_

◆ shearMethodTypeNames_

◆ dict_

◆ method_

◆ shearMethod_

◆ rhoName_

◆ rhoRef_

◆ CwPtr_

◆ dwfPtr_