LESeddyViscosity.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) 2013-2015 OpenFOAM Foundation
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::LESModels::LESeddyViscosity
26 
27 Group
28  grpLESTurbulence
29 
30 Description
31  Eddy viscosity LES SGS model base class
32 
33 SourceFiles
34  LESeddyViscosity.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef LESeddyViscosity_H
39 #define LESeddyViscosity_H
40 
41 #include "LESModel.H"
42 #include "eddyViscosity.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 namespace LESModels
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class LESeddyViscosity Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 template<class BasicTurbulenceModel>
56 class LESeddyViscosity
57 :
58  public eddyViscosity<LESModel<BasicTurbulenceModel> >
59 {
60  // Private Member Functions
61 
62  // Disallow default bitwise copy construct and assignment
64  LESeddyViscosity& operator=(const LESeddyViscosity&);
65 
66 
67 protected:
68 
69  // Protected data
70 
72 
73 
74 public:
75 
76  typedef typename BasicTurbulenceModel::alphaField alphaField;
77  typedef typename BasicTurbulenceModel::rhoField rhoField;
78  typedef typename BasicTurbulenceModel::transportModel transportModel;
79 
80 
81  // Constructors
82 
83  //- Construct from components
85  (
86  const word& type,
87  const alphaField& alpha,
88  const rhoField& rho,
89  const volVectorField& U,
90  const surfaceScalarField& alphaRhoPhi,
91  const surfaceScalarField& phi,
92  const transportModel& transport,
93  const word& propertiesName = turbulenceModel::propertiesName
94  );
95 
96 
97  //- Destructor
98  virtual ~LESeddyViscosity()
99  {}
100 
101 
102  // Member Functions
103 
104  //- Read model coefficients if they have changed
105  virtual bool read();
106 
107  //- Return sub-grid disipation rate
108  virtual tmp<volScalarField> epsilon() const;
109 };
110 
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 } // End namespace LESModels
115 } // End namespace Foam
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #ifdef NoRepository
120 # include "LESeddyViscosity.C"
121 #endif
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 #endif
126 
127 // ************************************************************************* //
A class for handling words, derived from string.
Definition: word.H:59
virtual tmp< volScalarField > epsilon() const
Return sub-grid disipation rate.
Namespace for OpenFOAM.
BasicTurbulenceModel::alphaField alphaField
virtual ~LESeddyViscosity()
Destructor.
const dimensionedScalar alpha
Fine-structure constant: default SI units: [].
virtual bool read()
Read model coefficients if they have changed.
BasicTurbulenceModel::rhoField rhoField
Eddy viscosity turbulence model base class.
Definition: eddyViscosity.H:52
fileName::Type type(const fileName &)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:589
surfaceScalarField & phi
BasicTurbulenceModel::transportModel transportModel
static const word propertiesName
Default name of the turbulence properties dictionary.
Eddy viscosity LES SGS model base class.
A class for managing temporary objects.
Definition: PtrList.H:118
U
Definition: pEqn.H:82