FreeFOAM The Cross-Platform CFD Toolkit
GenSGSStress.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::GenSGSStress
26 
27 Description
28  General base class for all incompressible models that directly
29  solve for the SGS stress tensor B.
30 
31  Contains tensor fields B (the SGS stress tensor) as well as scalar
32  fields for k (SGS turbulent energy) gamma (SGS viscosity) and epsilon
33  (SGS dissipation).
34 
35 SourceFiles
36  GenSGSStress.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef GenSGSStress_H
41 #define GenSGSStress_H
42 
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace incompressible
50 {
51 namespace LESModels
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class GenSGSStress Declaration
56 \*---------------------------------------------------------------------------*/
57 
59 :
60  virtual public LESModel
61 {
62  // Private Member Functions
63 
64  // Disallow default bitwise copy construct and assignment
65  GenSGSStress(const GenSGSStress&);
66  GenSGSStress& operator=(const GenSGSStress&);
67 
68 
69 protected:
70 
72 
74 
77 
78 
79 public:
80 
81  // Constructors
82 
83  //- Construct from components
85  (
86  const volVectorField& U,
87  const surfaceScalarField& phi,
89  );
90 
91 
92  //- Destructor
93  virtual ~GenSGSStress()
94  {}
95 
96 
97  // Member Functions
98 
99  //- Return the SGS turbulent kinetic energy.
100  virtual tmp<volScalarField> k() const
101  {
102  return 0.5*tr(B_);
103  }
104 
105  //- Return the SGS turbulent dissipation.
106  virtual tmp<volScalarField> epsilon() const
107  {
108  volScalarField K = k();
109  return ce_*K*sqrt(K)/delta();
110  }
111 
112  //- Return the SGS viscosity.
113  virtual tmp<volScalarField> nuSgs() const
114  {
115  return nuSgs_;
116  }
117 
118  //- Return the sub-grid stress tensor.
119  virtual tmp<volSymmTensorField> B() const
120  {
121  return B_;
122  }
123 
124  //- Return the effective sub-grid turbulence stress tensor
125  // including the laminar stress
126  virtual tmp<volSymmTensorField> devBeff() const;
127 
128  //- Returns div(B).
129  // This is the additional term due to the filtering of the NSE.
131 
132  //- Read LESProperties dictionary
133  virtual bool read();
134 };
135 
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 } // End namespace LESModels
140 } // End namespace incompressible
141 } // End namespace Foam
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
145 #endif
146 
147 // ************************ vim: set sw=4 sts=4 et: ************************ //