FreeFOAM The Cross-Platform CFD Toolkit
thermophysicalFunction.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) 1991-2010 OpenCFD Ltd.
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::thermophysicalFunction
26 
27 Description
28  Abstract base class for thermo-physical functions
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef thermophysicalFunction_H
33 #define thermophysicalFunction_H
34 
35 #include <OpenFOAM/scalar.H>
36 #include <OpenFOAM/IOstreams.H>
37 #include <OpenFOAM/typeInfo.H>
38 #include <OpenFOAM/autoPtr.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class thermophysicalFunction Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 {
52 
53 public:
54 
55  //- Runtime type information
56  TypeName("thermophysicalFunction");
57 
58 
59  // Declare run-time constructor selection tables
60 
62  (
63  autoPtr,
65  Istream,
66  (Istream& is),
67  (is)
68  );
69 
70 
71  // Constructors
72 
73  //- Construct null
75  {}
76 
77  //- Return a pointer to a new thermophysicalFunction created from input
79 
80 
81  // Destructor
82 
84  {}
85 
86 
87  // Member Functions
88 
89  //- Evaluate the function and return the result
90  virtual scalar f(scalar p, scalar T) const = 0;
91 
92  //- Write the function coefficients
93  virtual void writeData(Ostream& os) const = 0;
94 
95 
96  // Ostream Operator
97 
99  {
100  f.writeData(os);
101  return os;
102  }
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************ vim: set sw=4 sts=4 et: ************************ //