saturationModel.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) 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::saturationModel
26 
27 Description
28 
29 SourceFiles
30  saturationModel.C
31  newSaturationModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef saturationModel_H
36 #define saturationModel_H
37 
38 #include "volFields.H"
39 #include "dictionary.H"
40 #include "runTimeSelectionTables.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class saturationModel Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class saturationModel
52 {
53  // Private Member Functions
54 
55  //- Disallow default bitwise copy construct
57 
58  //- Disallow default bitwise assignment
59  void operator=(const saturationModel&);
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("saturationModel");
66 
67 
68  //- Declare runtime construction
70  (
71  autoPtr,
73  dictionary,
74  (
75  const dictionary& dict
76  ),
77  (dict)
78  );
79 
80 
81  // Constructors
82 
83  //- Construct null
85 
86 
87  // Selectors
88 
89  //- Select null constructed
90  static autoPtr<saturationModel> New(const dictionary& dict);
91 
92 
93  //- Destructor
94  virtual ~saturationModel();
95 
96 
97  // Member Functions
98 
99  //- Saturation pressure
100  virtual tmp<volScalarField> pSat
101  (
102  const volScalarField& T
103  ) const = 0;
104 
105  //- Saturation pressure derivetive w.r.t. temperature
107  (
108  const volScalarField& T
109  ) const = 0;
110 
111  //- Natural log of the saturation pressure
113  (
114  const volScalarField& T
115  ) const = 0;
116 
117  //- Saturation temperature
118  virtual tmp<volScalarField> Tsat
119  (
120  const volScalarField& p
121  ) const = 0;
122 };
123 
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 } // End namespace Foam
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 #endif
132 
133 // ************************************************************************* //
dictionary dict
virtual tmp< volScalarField > lnPSat(const volScalarField &T) const =0
Natural log of the saturation pressure.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
static autoPtr< saturationModel > New(const dictionary &dict)
Select null constructed.
declareRunTimeSelectionTable(autoPtr, saturationModel, dictionary,(const dictionary &dict),(dict))
Declare runtime construction.
virtual tmp< volScalarField > Tsat(const volScalarField &p) const =0
Saturation temperature.
saturationModel()
Construct null.
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
TypeName("saturationModel")
Runtime type information.
virtual tmp< volScalarField > pSat(const volScalarField &T) const =0
Saturation pressure.
virtual ~saturationModel()
Destructor.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
Macros to ease declaration of run-time selection tables.
volScalarField & p
A class for managing temporary objects.
Definition: PtrList.H:54
virtual tmp< volScalarField > pSatPrime(const volScalarField &T) const =0
Saturation pressure derivetive w.r.t. temperature.
Namespace for OpenFOAM.