FreeFOAM The Cross-Platform CFD Toolkit
thermoParcelInjectionData.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) 2010-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::thermoParcelInjectionData
26 
27 Description
28  Container class to provide injection data for thermodynamic parcels
29 
30 SourceFiles
31  thermoParcelInjectionData.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef thermoParcelInjectionData_H
36 #define thermoParcelInjectionData_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 // Forward declaration of classes
46 class thermoParcelInjectionData;
47 
48 // Forward declaration of friend functions
49 
50 Ostream& operator<<
51 (
52  Ostream&,
53  const thermoParcelInjectionData&
54 );
55 
56 Istream& operator>>
57 (
58  Istream&,
59  thermoParcelInjectionData&
60 );
61 
62 /*---------------------------------------------------------------------------*\
63  Class thermoParcelInjectionData Declaration
64 \*---------------------------------------------------------------------------*/
65 
67 :
69 {
70 protected:
71 
72  // Parcel properties
73 
74  //- Temperature [K]
75  scalar T_;
76 
77  //- Specific heat capacity [J/kg/K]
78  scalar cp_;
79 
80 
81 public:
82 
83  //- Runtime type information
84  TypeName("thermoParcelInjectionData");
85 
86  // Constructors
87 
88  //- Null constructor
90 
91  //- Construct from dictionary
93 
94  //- Construct from Istream
96 
97 
98  //-Destructor
100 
101 
102  // Access
103 
104  //- Return const access to the temperature
105  inline scalar T() const;
106 
107  //- Return const access to the specific heat capacity
108  inline scalar cp() const;
109 
110 
111  // Edit
112 
113  //- Return access to the temperature
114  inline scalar& T();
115 
116  //- Return access to the specific heat capacity
117  inline scalar& cp();
118 
119 
120  // I-O
121 
122  // Friend Operators
123 
124  friend bool operator==
125  (
126  const thermoParcelInjectionData& a,
128  )
129  {
131  (
132  "operator=="
133  "("
134  "const thermoParcelInjectionData&, "
135  "const thermoParcelInjectionData&"
136  ")"
137  );
138 
139  return false;
140  }
141 
142  friend bool operator!=
143  (
144  const thermoParcelInjectionData& a,
146  )
147  {
149  (
150  "operator=="
151  "("
152  "const thermoParcelInjectionData&, "
153  "const thermoParcelInjectionData&"
154  ")"
155  );
156 
157  return false;
158  }
159 
160  //- Ostream operator
161  friend Ostream& operator<<
162  (
163  Ostream& os,
164  const thermoParcelInjectionData& data
165  );
166 
167  //- Istream operator
168  friend Istream& operator>>
169  (
170  Istream& is,
172  );
173 };
174 
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 } // End namespace Foam
179 
180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
181 
183 
184 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
185 
186 #endif
187 
188 // ************************ vim: set sw=4 sts=4 et: ************************ //