saturationModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2015-2019 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 "IOdictionary.H"
39 #include "volFields.H"
40 #include "dictionary.H"
41 #include "runTimeSelectionTables.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class saturationModel Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class saturationModel
53 :
54  public IOdictionary
55 {
56 public:
57 
58  //- Runtime type information
59  TypeName("saturationModel");
60 
61 
62  //- Declare runtime construction
64  (
65  autoPtr,
67  dictionary,
68  (
69  const dictionary& dict, const objectRegistry& db
70  ),
71  (dict, db)
72  );
73 
74 
75  // Constructors
76 
77  //- Construct null
79 
80  //- Disallow default bitwise copy construction
81  saturationModel(const saturationModel&) = delete;
82 
83 
84  // Selectors
85 
86  //- Select null constructed
88  (
89  const dictionary& dict,
90  const objectRegistry& db
91  );
92 
93 
94  //- Destructor
95  virtual ~saturationModel();
96 
97 
98  // Member Functions
99 
100  //- Saturation pressure
101  virtual tmp<volScalarField> pSat
102  (
103  const volScalarField& T
104  ) const = 0;
105 
106  //- Saturation pressure derivetive w.r.t. temperature
108  (
109  const volScalarField& T
110  ) const = 0;
111 
112  //- Natural log of the saturation pressure
114  (
115  const volScalarField& T
116  ) const = 0;
117 
118  //- Saturation temperature
119  virtual tmp<volScalarField> Tsat
120  (
121  const volScalarField& p
122  ) const = 0;
123 
124 
125  // Member Operators
126 
127  //- Disallow default bitwise assignment
128  void operator=(const saturationModel&) = delete;
129 };
130 
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 } // End namespace Foam
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 #endif
139 
140 // ************************************************************************* //
void operator=(const saturationModel &)=delete
Disallow default bitwise assignment.
dictionary dict
virtual tmp< volScalarField > lnPSat(const volScalarField &T) const =0
Natural log of the saturation pressure.
static autoPtr< saturationModel > New(const dictionary &dict, const objectRegistry &db)
Select null constructed.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual tmp< volScalarField > Tsat(const volScalarField &p) const =0
Saturation temperature.
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:52
saturationModel(const objectRegistry &db)
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.
declareRunTimeSelectionTable(autoPtr, saturationModel, dictionary,(const dictionary &dict, const objectRegistry &db),(dict, db))
Declare runtime construction.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Macros to ease declaration of run-time selection tables.
volScalarField & p
A class for managing temporary objects.
Definition: PtrList.H:53
Registry of regIOobjects.
const objectRegistry & db() const
Return the local objectRegistry.
Definition: IOobject.C:354
virtual tmp< volScalarField > pSatPrime(const volScalarField &T) const =0
Saturation pressure derivetive w.r.t. temperature.
Namespace for OpenFOAM.