FreeFOAM The Cross-Platform CFD Toolkit
transportModel.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::transportModel
26 
27 Description
28  Base-class for all transport models used by the incompressible turbulence
29  models.
30 
31 SourceFiles
32  transportModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef transportModel_H
37 #define transportModel_H
38 
39 #include <OpenFOAM/IOdictionary.H>
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class transportModel Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public IOdictionary
55 {
56  // Private Member Functions
57 
58  //- Disallow copy construct
60 
61  //- Disallow default bitwise assignment
62  void operator=(const transportModel&);
63 
64 
65 public:
66 
67  // Constructors
68 
69  //- Construct from components
71  (
72  const volVectorField& U,
73  const surfaceScalarField& phi
74  );
75 
76 
77  // Destructor
78 
79  virtual ~transportModel();
80 
81 
82  // Member Functions
83 
84  //- Return the laminar viscosity
85  virtual tmp<volScalarField> nu() const = 0;
86 
87  //- Correct the laminar viscosity
88  virtual void correct() = 0;
89 
90  //- Read transportProperties dictionary
91  virtual bool read() = 0;
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************ vim: set sw=4 sts=4 et: ************************ //