reactingParcelInjectionData.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
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 "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
76  scalarList Y_;
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
93  reactingParcelInjectionData(Istream& is);
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  //- Ostream operator
115  friend Ostream& operator<<
116  (
117  Ostream& os,
119  );
120 
121  //- Istream operator
122  friend Istream& operator>>
123  (
124  Istream& is,
126  );
127 };
128 
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 } // End namespace Foam
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 #endif
141 
142 // ************************************************************************* //
Container class to provide injection data for thermodynamic parcels.
dictionary dict
Container class to provide injection data for reacting parcels.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const scalarList & Y() const
Return const access to the list of mass fractions.
TypeName("reactingParcelInjectionData")
Runtime type information.
Database for solution data, solver performance and other reduced data.
Definition: data.H:52
Namespace for OpenFOAM.
scalarList Y_
List of mass fractions.