File size: 10,674 Bytes
5a600cf
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2020-2026 OpenFOAM Foundation
     \\/     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::MPLICcell

Description
    Class performs geometric matching of volume fraction and calculates surface
    interpolation of volume fraction field.

    Cut algorithms:
    - Single cell cut
    - Face-edge walk multiple cell cuts
    - Tet decomposition cell cuts

SourceFiles
    MPLICcell.C

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

#ifndef MPLICcell_H
#define MPLICcell_H

#include "MPLICface.H"
#include "MPLICcellStorage.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
                          Class MPLICcell Declaration
\*---------------------------------------------------------------------------*/

class MPLICcell
{
    // Private Data

        // Face related objects

            //- Select unweighted interpolation if true
            // velocity flux corrected if false
            const bool unweighted_;

            //- Select multi-cut if true or single-cut if false
            const bool multiCut_;

            //- Surface interpolated alpha
            DynamicList<scalar> alphaf_;

            //- Flux of alpha from point interpolated U
            DynamicList<scalar> alphaPhiU_;

            //- Face flux from point interpolated U
            DynamicList<scalar> phiU_;


        // Geometry related objects

            //- Calculated volume fraction corresponding to the cut
            scalar cutAlpha_;

            //- Cut surface area vector
            vector cutSf_;

            //- Cut normal
            vector cutNormal_;

            //- Face cutter
            MPLICface faceCutter_;

            //- Sub cell volume
            scalar subCellVolume_;

            //- Cut points for single cut
            DynamicList<point> cutPoints_;

            //- Cut edge labels for single cut
            DynamicList<label> cutEdges_;

            //- Submerged face areas
            DynamicList<vector> subFaceAreas_;

            //- Submerged face areas
            DynamicList<scalar> subFaceMagSf_;

            //- Submerged face centers
            DynamicList<vector> subFaceCentres_;

            template<class Type>
            class Vector4
            :
                public VectorSpace<Vector4<Type>, Type, 4>
            {
            public:

                // Constructors

                //- Construct null
                inline Vector4()
                {}

                inline Type a() const
                {
                    return this->v_[0];
                }

                inline Type b() const
                {
                    return this->v_[1];
                }

                inline Type c() const
                {
                    return this->v_[2];
                }

                inline Type d() const
                {
                    return this->v_[3];
                }


                inline Type& a()
                {
                    return this->v_[0];
                }

                inline Type& b()
                {
                    return this->v_[1];
                }

                inline Type& c()
                {
                    return this->v_[2];
                }

                inline Type& d()
                {
                    return this->v_[3];
                }
            };

            typedef Vector4<scalar> vector4;

            //- Four point alpha values for cubic polynomial fit
            vector4 pCubicAlphas_;

            //- Four cell alpha values for cubic polynomial fit
            vector4 cCubicAlphas_;


        // Tetrahedron storage objects

            //- Tetrahedron alpha point values
            scalarField tetPointsAlpha_;

            //- Tetrahedron velocity point values
            vectorField tetPointsU_;

            //- Tetrahedron points
            pointField tetPoints_;

            //- Tetrahedron surface area vectors
            Vector4<vector> tetSf_;

            //- Tetrahedron face centres
            Vector4<vector> tetCf_;

            //- Tetrahedron triangular faces addressing
            const FixedList<face, 4> tetFaces_;


        // Multicut addressing

            //- Is addressing computed?
            bool addressingCalculated_;

            //- Local edge faces
            DynamicList<DynamicList<label>> localEdgeFaces_;

            //- Local face edges
            DynamicList<DynamicList<label>> localFaceEdges_;


        // Cell-point work arrays

            DynamicList<scalar> cellPointsAlpha_;

            DynamicList<scalar> pointsAlpha_;


    // Private Member Functions

        //- Match cell volume ratio to phase fraction
        //  Returns:
        //  - +1: success
        //  -  0: fail
        //  - -1: base scheme
        label calcMatchAlphaCutCell
        (
            const MPLICcellStorage& cellInfo,
            const bool tetDecom = false
        );

        //- Find in between which two point alpha values
        //  the target volume fraction lies
        void findPointAlphaBounds
        (
            const MPLICcellStorage& cellInfo,
            const bool tetDecom
        );

        //- Calculate the two interior point alpha values for the cubic fit
        void calcPointAlphaInterior
        (
            const MPLICcellStorage& cellInfo,
            const bool tetDecom
        );

        //- Solve the cubic fit
        FixedList<scalar, 4> solveVanderMatrix() const;

        //- Identifying roots of cubic equation matching target volume fraction
        void findRoots
        (
            const MPLICcellStorage& cellInfo,
            const FixedList<scalar, 4>& coeffs,
            const bool tetDecom
        );

        //- Select simple cut or tet decomposition
        scalar calcAlpha
        (
            const MPLICcellStorage& cellInfo,
            const scalar target,
            const bool tetDecom
        );

        //- Calculate current sub-cell volume
        void calcSubCellVolume();

        //- Calculate cell cut, volume and alpha
        scalar calcCutCellVolumeAlpha
        (
            const MPLICcellStorage& cellInfo,
            const scalar target
        );

        //- Calculate cell cut, volume and alpha by tet decomposition
        scalar calcTetCutCellVolumeAlpha
        (
            const MPLICcellStorage& cellInfo,
            const scalar target
        );

        //- Attempt single cut through the cell
        //  Returns:
        //  - 1: success
        //  - 0: fail
        bool singleCutCell
        (
            const MPLICcellStorage& cellInfo,
            const scalar target
        );

        //- Attempt multiple cuts through the cell
        bool multiCutCell
        (
            const MPLICcellStorage& cellInfo,
            const scalar target
        );

        //- Single cut through tet
        bool cutTetCell
        (
            const scalar target,
            const label faceOrig,
            const bool ow
        );

        //- Calculate local addressing for multi-cut
        inline void calcAddressing
        (
            const MPLICcellStorage& cellInfo
        );

        //- Append face area vectors and centers to cache
        inline void appendSfCf
        (
            const vector& Sf,
            const vector& Cf,
            const scalar magSf,
            const bool own = true
        );

        //- Calculating surface vector of unordered edges
        inline bool cutStatusCalcSf();

        //- Calculate cut surface area vector
        inline vector calcCutSf() const;

        //- Calculating surface center of unordered edges
        inline vector calcCutCf(const vector& cutSf) const;

        //- Calculate phiU
        inline void phiU
        (
            const pointField& points,
            const faceList& faces,
            const labelList& cFaces,
            const vectorField& pointsU
        );

        //- Resize and set all the cell face fields to 0
        inline void resetFaceFields(const label nFaces);

        //- Compute surface interpolation from area ratio
        inline void calcAlphaf(const UIndirectList<scalar>& magSfs);

        //- Compute surface interpolation from flux ratio
        inline void calcAlphaUf();

        //- Clear storage
        inline void clear();

        //- Clear single cut storage
        inline void clearOneCut();


public:

    // Constructors

        //- Construct for given interpolation and PLIC type
        MPLICcell
        (
            const bool unweighted = true,
            const bool multiCut = true
        );


    // Member functions

        //- Match cell volume ratios
        bool matchAlpha
        (
            const MPLICcellStorage& cellInfo
        );

        //- Return face volume fraction
        inline const DynamicList<scalar>& alphaf() const;

        //- Return cut normal
        inline const vector& cutNormal() const;

        //- Return volume fraction corresponding to the cut
        inline scalar cutAlpha() const;

        //- Return sub-cell volume
        inline scalar subCellVolume() const;
};


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

} // End namespace Foam

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

#include "MPLICcellI.H"

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

#endif

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