FreeFOAM The Cross-Platform CFD Toolkit
kinematicParcelInjectionData.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::kinematicParcelInjectionData
26 
27 Description
28  Container class to provide injection data for kinematic parcels
29 
30 SourceFiles
31  kinematicParcelInjectionData.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef kinematicParcelInjectionData_H
36 #define kinematicParcelInjectionData_H
37 
38 #include <OpenFOAM/dictionary.H>
39 #include <OpenFOAM/vector.H>
40 #include <OpenFOAM/point.H>
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 // Forward declaration of classes
48 class kinematicParcelInjectionData;
49 
50 // Forward declaration of friend functions
51 
52 Ostream& operator<<
53 (
54  Ostream&,
55  const kinematicParcelInjectionData&
56 );
57 
58 Istream& operator>>
59 (
60  Istream&,
61  kinematicParcelInjectionData&
62 );
63 
64 /*---------------------------------------------------------------------------*\
65  Class kinematicParcelInjectionData Declaration
66 \*---------------------------------------------------------------------------*/
67 
69 {
70 protected:
71 
72  // Parcel properties
73 
74  //- Position [m]
76 
77  //- Velocity [m/s]
79 
80  //- Diameter [m]
81  scalar d_;
82 
83  //- Density [kg/m3]
84  scalar rho_;
85 
86  //- Mass flow rate [kg/s]
87  scalar mDot_;
88 
89 
90 public:
91 
92  //- Runtime type information
93  TypeName("kinematicParcelInjectionData");
94 
95  // Constructors
96 
97  //- Null constructor
99 
100  //- Construct from dictionary
102 
103  //- Construct from Istream
105 
106 
107  //-Destructor
109 
110 
111  // Access
112 
113  //- Return const access to the position
114  inline const point& x() const;
115 
116  //- Return const access to the velocity
117  inline const vector& U() const;
118 
119  //- Return const access to the diameter
120  inline scalar d() const;
121 
122  //- Return const access to the density
123  inline scalar rho() const;
124 
125  //- Return const access to the mass flow rate
126  inline scalar mDot() const;
127 
128 
129  // Edit
130 
131  //- Return access to the position
132  inline point& x();
133 
134  //- Return access to the velocity
135  inline vector& U();
136 
137  //- Return access to the diameter
138  inline scalar& d();
139 
140  //- Return access to the density
141  inline scalar& rho();
142 
143  //- Return access to the mass flow rate
144  inline scalar& mDot();
145 
146 
147  // I-O
148 
149  // Friend Operators
150 
151  friend bool operator==
152  (
155  )
156  {
158  (
159  "operator=="
160  "("
161  "const kinematicParcelInjectionData&, "
162  "const kinematicParcelInjectionData&"
163  ")"
164  );
165 
166  return false;
167  }
168 
169  friend bool operator!=
170  (
173  )
174  {
176  (
177  "operator=="
178  "("
179  "const kinematicParcelInjectionData&, "
180  "const kinematicParcelInjectionData&"
181  ")"
182  );
183 
184  return false;
185  }
186 
187  //- Ostream operator
188  friend Ostream& operator<<
189  (
190  Ostream& os,
191  const kinematicParcelInjectionData& data
192  );
193 
194  //- Istream operator
195  friend Istream& operator>>
196  (
197  Istream& is,
199  );
200 };
201 
202 
203 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
204 
205 } // End namespace Foam
206 
207 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
208 
210 
211 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
212 
213 #endif
214 
215 // ************************ vim: set sw=4 sts=4 et: ************************ //