compressibleTransportModel.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) 2014 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::compressibleTransportModel
26 
27 Description
28  Base-class for all transport models used by the compressible turbulence
29  models.
30 
31 SourceFiles
32  compressibleTransportModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef compressibleTransportModel_H
37 #define compressibleTransportModel_H
38 
39 #include "primitiveFieldsFwd.H"
40 #include "volFieldsFwd.H"
41 #include "surfaceFieldsFwd.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class compressibleTransportModel Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 {
54  // Private Member Functions
55 
56  //- Disallow copy construct
58 
59  //- Disallow default bitwise assignment
60  void operator=(const compressibleTransportModel&);
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("compressibleTransportModel");
67 
68 
69  // Constructors
70 
71  //- Construct from components
73  ();
74 
75 
76  //- Destructor
78 
79 
80  // Member Functions
81 
82  //- Return the dynamic laminar viscosity
83  virtual tmp<volScalarField> mu() const = 0;
84 
85  //- Return the dynamic laminar viscosity for patch
86  virtual tmp<scalarField> mu(const label patchi) const = 0;
87 
88  //- Return the laminar viscosity
89  virtual tmp<volScalarField> nu() const = 0;
90 
91  //- Return the laminar viscosity for patch
92  virtual tmp<scalarField> nu(const label patchi) const = 0;
93 };
94 
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #endif
103 
104 // ************************************************************************* //
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 tmp< volScalarField > mu() const =0
Return the dynamic laminar viscosity.
Namespace for OpenFOAM.
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.
label patchi
Base-class for all transport models used by the compressible turbulence models.
TypeName("compressibleTransportModel")
Runtime type information.
virtual tmp< volScalarField > nu() const =0
Return the laminar viscosity.
A class for managing temporary objects.
Definition: PtrList.H:118
compressibleTransportModel()
Construct from components.