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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2014 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::compressibleTransportModel
28 
29 Description
30  Base-class for all transport models used by the compressible turbulence
31  models.
32 
33 SourceFiles
34  compressibleTransportModel.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef compressibleTransportModel_H
39 #define compressibleTransportModel_H
40 
41 #include "primitiveFieldsFwd.H"
42 #include "volFieldsFwd.H"
43 #include "surfaceFieldsFwd.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class compressibleTransportModel Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 {
56  // Private Member Functions
57 
58  //- No copy construct
60 
61  //- No copy assignment
62  void operator=(const compressibleTransportModel&) = delete;
63 
64 
65 public:
66 
67  //- Runtime type information
68  TypeName("compressibleTransportModel");
69 
70 
71  // Constructors
72 
73  //- Construct from components
75  ();
76 
77 
78  //- Destructor
80 
81 
82  // Member Functions
83 
84  //- Return the dynamic laminar viscosity
85  virtual tmp<volScalarField> mu() const = 0;
86 
87  //- Return the dynamic laminar viscosity for patch
88  virtual tmp<scalarField> mu(const label patchi) const = 0;
89 
90  //- Return the laminar viscosity
91  virtual tmp<volScalarField> nu() const = 0;
92 
93  //- Return the laminar viscosity for patch
94  virtual tmp<scalarField> nu(const label patchi) const = 0;
95 };
96 
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 } // End namespace Foam
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************************************************************* //
volFieldsFwd.H
primitiveFieldsFwd.H
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.
Foam::compressibleTransportModel::mu
virtual tmp< volScalarField > mu() const =0
Return the dynamic laminar viscosity.
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::compressibleTransportModel::nu
virtual tmp< volScalarField > nu() const =0
Return the laminar viscosity.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::compressibleTransportModel::compressibleTransportModel
compressibleTransportModel()
Construct from components.
Definition: compressibleTransportModel.C:40
Foam::compressibleTransportModel
Base-class for all transport models used by the compressible turbulence models.
Definition: compressibleTransportModel.H:53
Foam::compressibleTransportModel::~compressibleTransportModel
virtual ~compressibleTransportModel()
Destructor.
Definition: compressibleTransportModel.C:46
surfaceFieldsFwd.H
Foam::compressibleTransportModel::TypeName
TypeName("compressibleTransportModel")
Runtime type information.