src/thermophysicalModels/thermophysicalFunctions/thermophysicalFunction/thermophysicalFunction.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  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 "scalar.H"
  36 #include "IOstreams.H"
  37 #include "typeInfo.H"
  38 #include "autoPtr.H"
  39 #include "runTimeSelectionTables.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class thermophysicalFunction Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class thermophysicalFunction
  51 {
  52
  53 public:
  54
  55     //- Runtime type information
  56     TypeName("thermophysicalFunction");
  57
  58
  59     // Declare run-time constructor selection tables
  60
  61         declareRunTimeSelectionTable
  62         (
  63             autoPtr,
  64             thermophysicalFunction,
  65             Istream,
  66             (Istream& is),
  67             (is)
  68         );
  69
  70
  71     // Constructors
  72
  73         //- Construct null
  74         thermophysicalFunction()
  75         {}
  76
  77         //- Return a pointer to a new thermophysicalFunction created from input
  78         static autoPtr<thermophysicalFunction> New(Istream& is);
  79
  80
  81     // Destructor
  82
  83         virtual ~thermophysicalFunction()
  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
  98         friend Ostream& operator<<(Ostream& os, const thermophysicalFunction& f)
  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 // ************************************************************************* //