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::laminar
26 
27 Description
28  Turbulence model for laminar incompressible flow.
29 
30 SourceFiles
31  laminar.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef laminar_H
36 #define laminar_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace incompressible
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class laminar Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class laminar
52 :
53  public turbulenceModel
54 {
55 
56 public:
57 
58  //- Runtime type information
59  TypeName("laminar");
60 
61  // Constructors
62 
63  //- Construct from components
64  laminar
65  (
66  const volVectorField& U,
67  const surfaceScalarField& phi,
69  );
70 
71 
72  // Selectors
73 
74  //- Return a reference to the selected turbulence model
75  static autoPtr<laminar> New
76  (
77  const volVectorField& U,
78  const surfaceScalarField& phi,
79  transportModel& lamTransportModel
80  );
81 
82 
83  //- Destructor
84  virtual ~laminar()
85  {}
86 
87 
88  // Member Functions
89 
90  //- Return the turbulence viscosity, i.e. 0 for laminar flow
91  virtual tmp<volScalarField> nut() const;
92 
93  //- Return the effective viscosity, i.e. the laminar viscosity
94  virtual tmp<volScalarField> nuEff() const;
95 
96  //- Return the turbulence kinetic energy, i.e. 0 for laminar flow
97  virtual tmp<volScalarField> k() const;
98 
99  //- Return the turbulence kinetic energy dissipation rate,
100  // i.e. 0 for laminar flow
101  virtual tmp<volScalarField> epsilon() const;
102 
103  //- Return the Reynolds stress tensor, i.e. 0 for laminar flow
104  virtual tmp<volSymmTensorField> R() const;
105 
106  //- Return the effective stress tensor, i.e. the laminar stress
107  virtual tmp<volSymmTensorField> devReff() const;
108 
109  //- Return the source term for the momentum equation
110  virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
111 
112  //- Correct the laminar viscosity
113  virtual void correct();
114 
115  //- Read turbulenceProperties dictionary
116  virtual bool read();
117 };
118 
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 } // End namespace incompressible
123 } // End namespace Foam
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 #endif
128 
129 // ************************ vim: set sw=4 sts=4 et: ************************ //