FreeFOAM The Cross-Platform CFD Toolkit
reactingParcelInjectionData.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::reactingParcelInjectionData
26 
27 Description
28  Container class to provide injection data for reacting parcels
29 
30 SourceFiles
31  reactingParcelInjectionData.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef reactingParcelInjectionData_H
36 #define reactingParcelInjectionData_H
37 
39 #include <OpenFOAM/scalarList.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // Forward declaration of classes
47 class reactingParcelInjectionData;
48 
49 // Forward declaration of friend functions
50 
51 Ostream& operator<<
52 (
53  Ostream&,
54  const reactingParcelInjectionData&
55 );
56 
57 Istream& operator>>
58 (
59  Istream&,
60  reactingParcelInjectionData&
61 );
62 
63 /*---------------------------------------------------------------------------*\
64  Class reactingParcelInjectionData Declaration
65 \*---------------------------------------------------------------------------*/
66 
68 :
70 {
71 protected:
72 
73  // Parcel properties
74 
75  //- List of mass fractions
77 
78 
79 public:
80 
81  //- Runtime type information
82  TypeName("reactingParcelInjectionData");
83 
84  // Constructors
85 
86  //- Null constructor
88 
89  //- Construct from dictionary
91 
92  //- Construct from Istream
94 
95 
96  //-Destructor
98 
99 
100  // Access
101 
102  //- Return const access to the list of mass fractions
103  inline const scalarList& Y() const;
104 
105 
106  // Edit
107 
108  //- Return access to the mass fractions
109  inline scalarList& Y();
110 
111 
112  // I-O
113 
114  // Friend Operators
115 
116  friend bool operator==
117  (
120  )
121  {
123  (
124  "operator=="
125  "("
126  "const reactingParcelInjectionData&, "
127  "const reactingParcelInjectionData&"
128  ")"
129  );
130 
131  return false;
132  }
133 
134  friend bool operator!=
135  (
138  )
139  {
141  (
142  "operator=="
143  "("
144  "const reactingParcelInjectionData&, "
145  "const reactingParcelInjectionData&"
146  ")"
147  );
148 
149  return false;
150  }
151 
152  //- Ostream operator
153  friend Ostream& operator<<
154  (
155  Ostream& os,
156  const reactingParcelInjectionData& data
157  );
158 
159  //- Istream operator
160  friend Istream& operator>>
161  (
162  Istream& is,
164  );
165 };
166 
167 
168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
169 
170 } // End namespace Foam
171 
172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
173 
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 #endif
179 
180 // ************************ vim: set sw=4 sts=4 et: ************************ //