fluidThermo.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) 2012-2015 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::fluidThermo
26 
27 Description
28  Fundamental fluid thermodynamic properties
29 
30 SourceFiles
31  fluidThermo.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef fluidThermo_H
36 #define fluidThermo_H
37 
38 #include "basicThermo.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class fluidThermo Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class fluidThermo
51 :
52  public basicThermo,
54 {
55 
56 public:
57 
58  //- Runtime type information
59  TypeName("fluidThermo");
60 
61 
62  //- Declare run-time constructor selection table
64  (
65  autoPtr,
67  fvMesh,
68  (const fvMesh& mesh, const word& phaseName),
69  (mesh, phaseName)
70  );
71 
72  // Constructors
73 
74  //- Construct from mesh and phase name
76  (
77  const fvMesh&,
78  const word& phaseName
79  );
80 
81  //- Construct from mesh and phase name
83  (
84  const fvMesh&,
85  const dictionary&,
86  const word& phaseName
87  );
88 
89 
90  //- Selector
92  (
93  const fvMesh&,
94  const word& phaseName=word::null
95  );
96 
97 
98  //- Destructor
99  virtual ~fluidThermo();
100 
101 
102  // Member functions
103 
104  // Access to thermodynamic state variables
105 
106  //- Compressibility [s^2/m^2]
107  virtual const volScalarField& psi() const = 0;
108 
109 
110  // Access to transport state variables
111 
112  //- Dynamic viscosity of mixture [kg/m/s]
113  virtual tmp<volScalarField> mu() const = 0;
114 
115  //- Dynamic viscosity of mixture for patch [kg/m/s]
116  virtual tmp<scalarField> mu(const label patchi) const = 0;
117 
118  //- Kinematic viscosity of mixture [m^2/s]
119  virtual tmp<volScalarField> nu() const;
120 
121  //- Kinematic viscosity of mixture for patch [m^2/s]
122  virtual tmp<scalarField> nu(const label patchi) const;
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace Foam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
virtual tmp< volScalarField > mu() const =0
Dynamic viscosity of mixture [kg/m/s].
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
Abstract base-class for fluid and solid thermodynamic properties.
Definition: basicThermo.H:52
static autoPtr< fluidThermo > New(const fvMesh &, const word &phaseName=word::null)
Selector.
Definition: fluidThermo.C:60
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual ~fluidThermo()
Destructor.
Definition: fluidThermo.C:71
Base-class for all transport models used by the compressible turbulence models.
dynamicFvMesh & mesh
A class for handling words, derived from string.
Definition: word.H:59
Fundamental fluid thermodynamic properties.
Definition: fluidThermo.H:49
static const word null
An empty word.
Definition: word.H:77
virtual tmp< volScalarField > nu() const
Kinematic viscosity of mixture [m^2/s].
Definition: fluidThermo.C:77
TypeName("fluidThermo")
Runtime type information.
label patchi
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
virtual const volScalarField & psi() const =0
Compressibility [s^2/m^2].
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
A class for managing temporary objects.
Definition: PtrList.H:54
declareRunTimeSelectionTable(autoPtr, fluidThermo, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName))
Declare run-time constructor selection table.
Namespace for OpenFOAM.
fluidThermo(const fvMesh &, const word &phaseName)
Construct from mesh and phase name.
Definition: fluidThermo.C:39