SprayParcel.H 11.4 KB
Newer Older
andy's avatar
andy committed
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2011-2011 OpenCFD Ltd.
andy's avatar
andy committed
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

Class
    Foam::SprayParcel

Description
28
    Reacing spray parcel, with added functionality for atomization and breakup
andy's avatar
andy committed
29
30
31
32
33
34

\*---------------------------------------------------------------------------*/

#ifndef SprayParcel_H
#define SprayParcel_H

35
#include "particle.H"
andy's avatar
andy committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

template<class ParcelType>
class SprayParcel;

template<class ParcelType>
Ostream& operator<<
(
    Ostream&,
    const SprayParcel<ParcelType>&
);

/*---------------------------------------------------------------------------*\
                          Class SprayParcel Declaration
\*---------------------------------------------------------------------------*/

template<class ParcelType>
class SprayParcel
:
59
    public ParcelType
andy's avatar
andy committed
60
{
61

andy's avatar
andy committed
62
63
protected:

64
    // Protected data
andy's avatar
andy committed
65

66
        // Spray parcel properties
andy's avatar
andy committed
67

andy's avatar
andy committed
68
            //- Initial droplet diameter
andy's avatar
andy committed
69
70
            scalar d0_;

andy's avatar
andy committed
71
            //- Injection position
andy's avatar
andy committed
72
73
            vector position0_;

andy's avatar
andy committed
74
            //- Part of liquid core ( >0.5=liquid, <0.5=droplet )
andy's avatar
andy committed
75
76
            scalar liquidCore_;

andy's avatar
andy committed
77
            //- Index for KH Breakup
andy's avatar
andy committed
78
79
            scalar KHindex_;

andy's avatar
andy committed
80
            //- Spherical deviation
andy's avatar
andy committed
81
82
            scalar y_;

andy's avatar
andy committed
83
            //- Rate of change of spherical deviation
andy's avatar
andy committed
84
85
            scalar yDot_;

andy's avatar
andy committed
86
            //- Characteristic time (used in atomization and/or breakup model)
andy's avatar
andy committed
87
88
            scalar tc_;

andy's avatar
andy committed
89
            //- Stripped parcel mass due to breakup
andy's avatar
andy committed
90
91
            scalar ms_;

andy's avatar
andy committed
92
93
            //- Injected from injector (needed e.g. for calculating distance
            //  from injector)
andy's avatar
andy committed
94
95
            scalar injector_;

andy's avatar
andy committed
96
            //- Momentum relaxation time (needed for calculating parcel acc.)
andy's avatar
andy committed
97
98
            scalar tMom_;

andy's avatar
andy committed
99
            //- Passive scalar (extra variable to be defined by user)
andy's avatar
andy committed
100
101
102
            scalar user_;


103
public:
andy's avatar
andy committed
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

    // Static data members

        //- String representation of properties
        static string propHeader;

        //- Runtime type information
        TypeName("SprayParcel");


    // Constructors

        //- Construct from owner, position, and cloud owner
        //  Other properties initialised as null
        inline SprayParcel
        (
120
            const polyMesh& mesh,
andy's avatar
andy committed
121
            const vector& position,
122
123
124
            const label cellI,
            const label tetFaceI,
            const label tetPtI
andy's avatar
andy committed
125
126
127
128
129
        );

        //- Construct from components
        inline SprayParcel
        (
130
            const polyMesh& mesh,
andy's avatar
andy committed
131
132
            const vector& position,
            const label cellI,
133
134
            const label tetFaceI,
            const label tetPtI,
andy's avatar
andy committed
135
136
137
            const label typeId,
            const scalar nParticle0,
            const scalar d0,
138
            const scalar dTarget0,
andy's avatar
andy committed
139
            const vector& U0,
140
141
142
            const vector& f0,
            const vector& angularMomentum0,
            const vector& torque0,
andy's avatar
andy committed
143
            const scalarField& Y0,
144
145
146
147
148
149
150
151
152
153
            const scalar liquidCore,
            const scalar KHindex,
            const scalar y,
            const scalar yDot,
            const scalar tc,
            const scalar ms,
            const scalar injector,
            const scalar tMom,
            const scalar user,
            const typename ParcelType::constantProperties& constProps
andy's avatar
andy committed
154
155
156
157
158
        );

        //- Construct from Istream
        SprayParcel
        (
159
            const polyMesh& mesh,
andy's avatar
andy committed
160
161
162
163
            Istream& is,
            bool readFields = true
        );

164
165
166
167
168
169
170
        //- Construct as a copy
        SprayParcel
        (
            const SprayParcel& p,
            const polyMesh& mesh
        );

andy's avatar
andy committed
171
172
173
        //- Construct as a copy
        SprayParcel(const SprayParcel& p);

174
175
        //- Construct and return a (basic particle) clone
        virtual autoPtr<particle> clone() const
andy's avatar
andy committed
176
        {
177
            return autoPtr<particle>(new SprayParcel<ParcelType>(*this));
andy's avatar
andy committed
178
179
        }

180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
        //- Construct and return a (basic particle) clone
        virtual autoPtr<particle> clone(const polyMesh& mesh) const
        {
            return autoPtr<particle>
            (
                new SprayParcel<ParcelType>(*this, mesh)
            );
        }

        //- Factory class to read-construct particles used for
        //  parallel transfer
        class iNew
        {
            const polyMesh& mesh_;

        public:

            iNew(const polyMesh& mesh)
            :
                mesh_(mesh)
            {}

            autoPtr<SprayParcel<ParcelType> > operator()(Istream& is) const
            {
                return autoPtr<SprayParcel<ParcelType> >
                (
                    new SprayParcel<ParcelType>(mesh_, is, true)
                );
            }
        };


andy's avatar
andy committed
212
213
214
215
216
    // Member Functions

        // Access

            //- Return const access to initial droplet diameter
217
            inline scalar d0() const;
andy's avatar
andy committed
218
219
220
221
222

            //- Return const access to initial droplet position
            inline const vector& position0() const;

            //- Return const access to liquid core
223
            inline scalar liquidCore() const;
andy's avatar
andy committed
224
225

            //- Return const access to Kelvin-Helmholtz breakup index
226
            inline scalar KHindex() const;
andy's avatar
andy committed
227
228

            //- Return const access to spherical deviation
229
            inline scalar y() const;
andy's avatar
andy committed
230
231

            //- Return const access to rate of change of spherical deviation
232
            inline scalar yDot() const;
andy's avatar
andy committed
233
234

            //- Return const access to atomization characteristic time
235
            inline scalar tc() const;
andy's avatar
andy committed
236
237

            //- Return const access to stripped parcel mass
238
            inline scalar ms() const;
andy's avatar
andy committed
239
240

            //- Return const access to injector id
241
            inline scalar injector() const;
andy's avatar
andy committed
242
243

            //- Return const access to momentum relaxation time
244
            inline scalar tMom() const;
andy's avatar
andy committed
245
246

            //- Return const access to passive user scalar
247
248
            inline scalar user() const;

andy's avatar
andy committed
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346

        // Edit

            //- Return access to initial droplet diameter
            inline scalar& d0();

            //- Return access to initial droplet position
            inline vector& position0();

            //- Return access to liquid core
            inline scalar& liquidCore();

            //- Return access to Kelvin-Helmholtz breakup index
            inline scalar& KHindex();

            //- Return access to spherical deviation
            inline scalar& y();

            //- Return access to rate of change of spherical deviation
            inline scalar& yDot();

            //- Return access to atomization characteristic time
            inline scalar& tc();

            //- Return access to stripped parcel mass
            inline scalar& ms();

            //- Return access to injector id
            inline scalar& injector();

            //- Return access to momentum relaxation time
            inline scalar& tMom();

            //- Return access to passive user scalar
            inline scalar& user();


        // Main calculation loop

            //- Set cell values
            template<class TrackData>
            void setCellValues
            (
                TrackData& td,
                const scalar dt,
                const label cellI
            );

            //- Correct parcel properties according to atomization model
            template<class TrackData>
            void calcAtomization
            (
                TrackData& td,
                const scalar dt,
                const label cellI
            );

            //- Correct parcel properties according to breakup model
            template<class TrackData>
            void calcBreakup
            (
                TrackData& td,
                const scalar dt,
                const label cellI
            );

            //- Correct cell values using latest transfer information
            template<class TrackData>
            void cellValueSourceCorrection
            (
                TrackData& td,
                const scalar dt,
                const label cellI
            );

            //- Correct surface values due to emitted species
            template<class TrackData>
            void correctSurfaceValues
            (
                TrackData& td,
                const label cellI,
                const scalar T,
                const scalarField& Cs,
                scalar& rhos,
                scalar& mus,
                scalar& Pr,
                scalar& kappa
            );

            //- Update parcel properties over the time interval
            template<class TrackData>
            void calc
            (
                TrackData& td,
                const scalar dt,
                const label cellI
            );

347
348
            //- Calculate the chi-factor for flash-boiling for the
            //  atomization model
andy's avatar
andy committed
349
350
351
352
353
354
355
356
357
358
359
360
            template<class TrackData>
            scalar chi
            (
                TrackData& td,
                const scalarField& X
            ) const;

            //- Solve the TAB equation
            template<class TrackData>
            void solveTABEq
            (
                TrackData& td,
361
                const scalar dt
andy's avatar
andy committed
362
363
            );

364

andy's avatar
andy committed
365
366
367
        // I-O

            //- Read
368
369
370
371
372
373
374
375
376
377
            template<class CloudType, class CompositionType>
            static void readFields
            (
                CloudType& c,
                const CompositionType& compModel
            );

            //- Read - no composition
            template<class CloudType>
            static void readFields(CloudType& c);
andy's avatar
andy committed
378
379

            //- Write
380
381
382
383
384
385
386
387
388
389
            template<class CloudType, class CompositionType>
            static void writeFields
            (
                const CloudType& c,
                const CompositionType& compModel
            );

            //- Write - composition supplied
            template<class CloudType>
            static void writeFields(const CloudType& c);
andy's avatar
andy committed
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421


    // Ostream Operator

        friend Ostream& operator<< <ParcelType>
        (
            Ostream&,
            const SprayParcel<ParcelType>&
        );
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#include "SprayParcelI.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#ifdef NoRepository
    #include "SprayParcel.C"
#endif


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //