FreeFOAM The Cross-Platform CFD Toolkit
laminar.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::incompressible::LESModels::laminar
26 
27 Description
28  LES model for laminar incompressible flow.
29  It simply returns laminar properties.
30 
31 SourceFiles
32  laminar.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef lesLaminar_H
37 #define lesLaminar_H
38 
40 #include <finiteVolume/volFields.H>
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace incompressible
47 {
48 namespace LESModels
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class laminar Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class laminar
56 :
57  public LESModel
58 {
59  // Private member functions
60 
61  // Disallow default bitwise copy construct and assignment
62  laminar(const laminar&);
63  laminar& operator=(const laminar&);
64 
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("laminar");
70 
71 
72  // Constructors
73 
74  //- Construct from components
75  laminar
76  (
77  const volVectorField& U,
78  const surfaceScalarField& phi,
80  );
81 
82 
83  //- Destructor
84  virtual ~laminar()
85  {}
86 
87 
88  // Member Functions
89 
90  //- Return SGS kinetic energy
91  virtual tmp<volScalarField> k() const;
92 
93  //- Return sub-grid disipation rate
94  virtual tmp<volScalarField> epsilon() const;
95 
96  //- Return SGS viscosity
97  virtual tmp<volScalarField> nuSgs() const;
98 
99  //- Return the effective viscosity
100  virtual tmp<volScalarField> nuEff() const;
101 
102  //- Return the sub-grid stress tensor B.
103  virtual tmp<volSymmTensorField> B() const;
104 
105  //- Return the deviatoric part of the effective sub-grid
106  // turbulence stress tensor including the laminar stress
107  virtual tmp<volSymmTensorField> devBeff() const;
108 
109  //- Return the deviatoric part of the divergence of Beff
110  // i.e. the additional term in the filtered NSE.
112 
113  //- Read LESProperties dictionary
114  bool read();
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace LESModels
121 } // End namespace incompressible
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************ vim: set sw=4 sts=4 et: ************************ //