laminar.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2020-2023 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "laminar.H"
30 
31 
32 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 namespace regionModels
37 {
38 namespace areaSurfaceFilmModels
39 {
40 
41 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
42 
45 
46 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
47 
48 laminar::laminar
49 (
50  liquidFilmBase& film,
51  const dictionary& dict
52 )
53 :
54  filmTurbulenceModel(type(), film, dict)
55 {}
56 
57 
58 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
59 
61 {
62  auto tmut = tmp<areaScalarField>::New
63  (
64  IOobject
65  (
66  "mut",
67  film().regionMesh().time().timeName(),
68  film().regionMesh().thisDb(),
71  ),
72  film().regionMesh(),
74  );
75 
76  return tmut;
77 }
78 
79 
80 void laminar::correct()
81 {}
82 
83 
85 {
87 }
88 
89 
91 {
92  // local references to film fields
94  tmp<areaScalarField> wf = Cw();
95 
96  return
97  (
98  - fam::Sp(wf(), U) + wf()*Uw() // wall contribution
99  );
100 }
101 
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 } // End namespace areaSurfaceFilmModels
106 } // End namespace regionModels
107 } // End namespace Foam
108 
109 // ************************************************************************* //
dictionary dict
tmp< faVectorMatrix > wallFriction(areaVectorField &U) const
Wall friction.
Definition: laminar.C:83
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
tmp< faVectorMatrix > primaryRegionFriction(areaVectorField &U) const
Return primary region friction.
Ignore writing from objectRegistry::writeObject()
defineTypeNameAndDebug(kinematicThinFilm, 0)
Macros for easy insertion into run-time selection tables.
word timeName
Definition: getTimeIndex.H:3
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: POSIX.C:799
zeroField Sp(const Foam::zero, const GeometricField< Type, faPatchField, areaMesh > &)
A no-op source.
const liquidFilmBase & film_
Reference to liquidFilmBase.
virtual void correct()
Correct/update the model.
Definition: laminar.C:73
virtual tmp< faVectorMatrix > Su(areaVectorField &U) const
Return the source for the film momentum equation.
Definition: laminar.C:77
addToRunTimeSelectionTable(liquidFilmBase, kinematicThinFilm, dictionary)
static tmp< T > New(Args &&... args)
Construct tmp with forwarding arguments.
Definition: tmp.H:206
virtual tmp< areaScalarField > Cw() const
Return the wall film surface friction.
U
Definition: pEqn.H:72
const dimensionSet dimLength(0, 1, 0, 0, 0, 0, 0)
Definition: dimensionSets.H:50
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
Nothing to be read.
const dimensionSet dimTime(0, 0, 1, 0, 0, 0, 0)
Definition: dimensionSets.H:51
tmp< areaVectorField > Uw() const
Wall velocity.
const dimensionSet dimMass(1, 0, 0, 0, 0, 0, 0)
Definition: dimensionSets.H:49
virtual tmp< areaScalarField > mut() const
Return the film turbulence viscosity.
Definition: laminar.C:53
A class for managing temporary objects.
Definition: HashPtrTable.H:50
Defines the attributes of an object for which implicit objectRegistry management is supported...
Definition: IOobject.H:172
Namespace for OpenFOAM.
Film laminar turbulence model.
Definition: laminar.H:51