src/lagrangian/intermediate/submodels/Thermodynamic/InjectionModel/ThermoLookupTableInjection/thermoParcelInjectionData.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::thermoParcelInjectionData
  27
  28 Description
  29     Container class to provide injection data for thermodynamic parcels
  30
  31 SourceFiles
  32     thermoParcelInjectionData.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef thermoParcelInjectionData_H
  37 #define thermoParcelInjectionData_H
  38
  39 #include "kinematicParcelInjectionData.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 // Forward declaration of classes
  47 class thermoParcelInjectionData;
  48
  49 // Forward declaration of friend functions
  50
  51 Ostream& operator<<
  52 (
  53     Ostream&,
  54     const thermoParcelInjectionData&
  55 );
  56
  57 Istream& operator>>
  58 (
  59     Istream&,
  60     thermoParcelInjectionData&
  61 );
  62
  63 /*---------------------------------------------------------------------------*\
  64                  Class thermoParcelInjectionData Declaration
  65 \*---------------------------------------------------------------------------*/
  66
  67 class thermoParcelInjectionData
  68 :
  69     public kinematicParcelInjectionData
  70 {
  71 protected:
  72
  73     // Parcel properties
  74
  75         //- Temperature [K]
  76         scalar T_;
  77
  78         //- Specific heat capacity [J/kg/K]
  79         scalar cp_;
  80
  81
  82 public:
  83
  84     //- Runtime type information
  85     TypeName("thermoParcelInjectionData");
  86
  87     // Constructors
  88
  89         //- Null constructor
  90         thermoParcelInjectionData();
  91
  92         //- Construct from dictionary
  93         thermoParcelInjectionData(const dictionary& dict);
  94
  95         //- Construct from Istream
  96         thermoParcelInjectionData(Istream& is);
  97
  98
  99     //-Destructor
 100     virtual ~thermoParcelInjectionData();
 101
 102
 103     // Access
 104
 105         //- Return const access to the temperature
 106         inline scalar T() const;
 107
 108         //- Return const access to the specific heat capacity
 109         inline scalar cp() const;
 110
 111
 112     // Edit
 113
 114         //- Return access to the temperature
 115         inline scalar& T();
 116
 117         //- Return access to the specific heat capacity
 118         inline scalar& cp();
 119
 120
 121     // I-O
 122
 123         // Friend Operators
 124
 125             friend bool operator==
 126             (
 127                 const thermoParcelInjectionData& a,
 128                 const thermoParcelInjectionData& b
 129             )
 130             {
 131                 notImplemented
 132                 (
 133                     "operator=="
 134                     "("
 135                         "const thermoParcelInjectionData&, "
 136                         "const thermoParcelInjectionData&"
 137                     ")"
 138                 );
 139
 140                 return false;
 141             }
 142
 143             friend bool operator!=
 144             (
 145                 const thermoParcelInjectionData& a,
 146                 const thermoParcelInjectionData& b
 147             )
 148             {
 149                 notImplemented
 150                 (
 151                     "operator=="
 152                     "("
 153                         "const thermoParcelInjectionData&, "
 154                         "const thermoParcelInjectionData&"
 155                     ")"
 156                 );
 157
 158                 return false;
 159             }
 160
 161             //- Ostream operator
 162             friend Ostream& operator<<
 163             (
 164                 Ostream& os,
 165                 const thermoParcelInjectionData& data
 166             );
 167
 168             //- Istream operator
 169             friend Istream& operator>>
 170             (
 171                 Istream& is,
 172                 thermoParcelInjectionData& data
 173             );
 174 };
 175
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 } // End namespace Foam
 180
 181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 182
 183 #include "thermoParcelInjectionDataI.H"
 184
 185 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 186
 187 #endif
 188
 189 // ************************************************************************* //