singlePhaseTransportModel.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) 2011 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::singlePhaseTransportModel
26 
27 Description
28  A simple single-phase transport model based on viscosityModel.
29 
30  Used by the incompressible single-phase solvers like simpleFoam,
31  turbFoam etc.
32 
33 SourceFiles
34  singlePhaseTransportModel.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef singlePhaseTransportModel_H
39 #define singlePhaseTransportModel_H
40 
42 #include "IOdictionary.H"
43 #include "autoPtr.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 class viscosityModel;
51 
52 /*---------------------------------------------------------------------------*\
53  Class singlePhaseTransportModel Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
58  public IOdictionary,
59  public transportModel
60 {
61  // Private Data
62 
63  autoPtr<viscosityModel> viscosityModelPtr_;
64 
65 
66  // Private Member Functions
67 
68  //- Disallow copy construct
70 
71  //- Disallow default bitwise assignment
72  void operator=(const singlePhaseTransportModel&);
73 
74 
75 public:
76 
77  // Constructors
78 
79  //- Construct from components
81  (
82  const volVectorField& U,
83  const surfaceScalarField& phi
84  );
85 
86 
87  //- Destructor
89 
90 
91  // Member Functions
92 
93  //- Return the laminar viscosity
94  virtual tmp<volScalarField> nu() const;
95 
96  //- Return the laminar viscosity for patch
97  virtual tmp<scalarField> nu(const label patchi) const;
98 
99  //- Correct the laminar viscosity
100  virtual void correct();
101 
102  //- Read transportProperties dictionary
103  virtual bool read();
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
virtual ~singlePhaseTransportModel()
Destructor.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
virtual bool read()
Read transportProperties dictionary.
Namespace for OpenFOAM.
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:53
label patchi
A simple single-phase transport model based on viscosityModel.
surfaceScalarField & phi
virtual tmp< volScalarField > nu() const
Return the laminar viscosity.
Base-class for all transport models used by the incompressible turbulence models. ...
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
A class for managing temporary objects.
Definition: PtrList.H:118
U
Definition: pEqn.H:82
virtual void correct()
Correct the laminar viscosity.