File size: 14,214 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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2018-2025 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/>.

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

#include "cutPolyIntegral.H"
#include <utility>

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

namespace Foam
{
namespace cutPoly
{

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

template<class Int, Int Offset, class Sequence>
struct OffsetSequence;

template<class Int, Int Offset, Int ... Is>
struct OffsetSequence<Int, Offset, std::integer_sequence<Int, Is ...>>
{
    using type = std::integer_sequence<Int, Is + Offset ...>;
};


template<class Int, Int Min, Int Max>
struct RangeSequence
{
    using type =
        typename OffsetSequence
        <
            Int,
            Min,
            std::make_index_sequence<Max - Min>
        >::type;
};


template<class Tuple, class Int, Int ... Is>
auto tupleSubset
(
    const Tuple& tuple,
    const std::integer_sequence<Int, Is ...>&
)
{
    return std::make_tuple(std::get<Is>(tuple) ...);
}


template<class Op, class Tuple, class Int, Int ... Is>
auto tupleSubset
(
    const Tuple& tuple,
    const std::integer_sequence<Int, Is ...>&,
    const Op& op
)
{
    return std::make_tuple(op(std::get<Is>(tuple)) ...);
}


template<class ... Types>
auto tupleTail(const std::tuple<Types ...>& tuple)
{
    return
        tupleSubset
        (
            tuple,
            typename RangeSequence<std::size_t, 1, sizeof ... (Types)>::type()
        );
}


template<class Op, class ... Types>
auto tupleOp(const std::tuple<Types ...>& tuple, const Op& op)
{
    return
        tupleSubset
        (
            tuple,
            std::make_index_sequence<sizeof ... (Types)>(),
            op
        );
}


template<class Op, class Tuple, class Int, Int ... Is>
void tupleInPlaceOp
(
    Tuple& tuple,
    const std::integer_sequence<Int, Is ...>&,
    const Op& op
)
{
    (void)std::initializer_list<nil>
    {(
        op(std::get<Is>(tuple)),
        nil()
    ) ... };
}


template<class Op, class ... Types>
void tupleInPlaceOp(std::tuple<Types ...>& tuple, const Op& op)
{
    tupleInPlaceOp(tuple, std::make_index_sequence<sizeof ... (Types)>(), op);
}


template<class BinaryOp, class Tuple, class Int, Int ... Is>
auto tupleBinaryOp
(
    const Tuple& tupleA,
    const Tuple& tupleB,
    const std::integer_sequence<Int, Is ...>&,
    const BinaryOp& bop
)
{
    return std::make_tuple(bop(std::get<Is>(tupleA), std::get<Is>(tupleB)) ...);
}


template<class BinaryOp, class ... TypesA, class ... TypesB>
auto tupleBinaryOp
(
    const std::tuple<TypesA ...>& tupleA,
    const std::tuple<TypesB ...>& tupleB,
    const BinaryOp& bop
)
{
    return tupleBinaryOp
    (
        tupleA,
        tupleB,
        std::make_index_sequence<sizeof ... (TypesA)>(),
        bop
    );
}

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

} // End namespace cutPoly
} // End namespace Foam

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

template<template<class> class FaceValues, class ... Types>
Foam::Tuple2
<
    Foam::vector,
    std::tuple<Foam::cutPoly::AreaIntegralType<Types> ...>
>
Foam::cutPoly::faceAreaIntegral
(
    const FaceValues<point>& fPs,
    const point& fPAvg,
    const std::tuple<FaceValues<Types> ...>& fPsis,
    const std::tuple<Types ...>& fPsiAvgs
)
{
    vector fCutsArea = Zero;
    auto fCutsAreaPsi = std::make_tuple(AreaIntegralType<Types>(Zero) ...);

    typename FaceValues<point>::const_iterator fPIter(fPs.begin());
    auto fPsiIter = tupleOp(fPsis, OpBegin());

    for(; fPIter != fPs.end(); ++ fPIter)
    {
        const point p0 = *fPIter;
        const point p1 = fPIter.next();
        auto psi0 = tupleOp(fPsiIter, OpDereference());
        auto psi1 = tupleOp(fPsiIter, OpNext());

        const vector a = ((p1 - p0)^(fPAvg - p0))/2;

        fCutsArea += a;
        fCutsAreaPsi =
            tupleBinaryOp
            (
                fCutsAreaPsi,
                tupleOp
                (
                    tupleBinaryOp
                    (
                        psi0,
                        tupleBinaryOp
                        (
                            psi1,
                            fPsiAvgs,
                            BinaryOpAdd()
                        ),
                        BinaryOpAdd()
                    ),
                    OpScaled<vector>(a/3)
                ),
                BinaryOpAdd()
            );

        tupleInPlaceOp(fPsiIter, InPlaceOpAdvance());
    }

    return
        Tuple2<vector, std::tuple<AreaIntegralType<Types> ...>>
        (
            fCutsArea,
            fCutsAreaPsi
        );
}


template<template<class> class FaceValues, class ... Types>
Foam::Tuple2<Foam::vector, std::tuple<Types ...>>
Foam::cutPoly::faceAreaAverage
(
    const FaceValues<point>& fPs,
    const point& fPAvg,
    const std::tuple<FaceValues<Types> ...>& fPsis,
    const std::tuple<Types ...>& fPsiAvgs
)
{
    auto fSumPPsis = faceAreaIntegral(fPs, fPAvg, fPsis, fPsiAvgs);

    const vector& fArea = fSumPPsis.first();
    const scalar fMagSqrArea = magSqr(fArea);

    return
        Tuple2<vector, std::tuple<Types ...>>
        (
            fArea,
            fMagSqrArea > vSmall
          ? tupleOp(fSumPPsis.second(), OpPreInner(fArea/fMagSqrArea))
          : fPsiAvgs
        );
}


template<class ... Types>
Foam::Tuple2
<
    Foam::vector,
    std::tuple<Foam::cutPoly::AreaIntegralType<Types> ...>
>
Foam::cutPoly::faceCutAreaIntegral
(
    const face& f,
    const vector& fArea,
    const std::tuple<Types ...>& fPsis,
    const List<labelPair>& fCuts,
    const pointField& ps,
    const std::tuple<const Field<Types>& ...>& pPsis,
    const scalarField& pAlphas,
    const scalar isoAlpha,
    const bool below
)
{
    // If there are no cuts return either the entire face or zero, depending on
    // which side of the iso-surface the face is
    if (fCuts.size() == 0)
    {
        if ((pAlphas[f[0]] < isoAlpha) == below)
        {
            return
                Tuple2<vector, std::tuple<AreaIntegralType<Types> ...>>
                (
                    fArea,
                    tupleOp(fPsis, OpScaled<vector>(fArea))
                );
        }
        else
        {
            return
                Tuple2<vector, std::tuple<AreaIntegralType<Types> ...>>
                (
                    vector::zero,
                    std::make_tuple(pTraits<AreaIntegralType<Types>>::zero ...)
                );
        }
    }

    return
        faceAreaIntegral
        (
            FaceCutValues<vector>(f, fCuts, ps, pAlphas, isoAlpha, below),
            OpIndirectAverage(f)(ps),
            tupleOp(pPsis, OpFaceCutValues(f, fCuts, pAlphas, isoAlpha, below)),
            tupleOp(pPsis, OpIndirectAverage(f))
        );
}


template<class ... Types>
Foam::Tuple2<Foam::scalar, std::tuple<Types ...>>
Foam::cutPoly::cellVolumeIntegral
(
    const cell& c,
    const cellEdgeAddressing& cAddr,
    const point& cPAvg,
    const std::tuple<Types ...>& cPsiAvgs,
    const vectorField& fAreas,
    const pointField& fCentres,
    const std::tuple<const Field<Types>& ...>& fPsis
)
{
    scalar cVolume = 0;
    std::tuple<Types ...> cVolumePsis(pTraits<Types>::zero ...);

    forAll(c, cfi)
    {
        const scalar pyrVolume =
            (cAddr.cOwns()[cfi] ? +1 : -1)
           *(fAreas[c[cfi]] & (fCentres[c[cfi]] - cPAvg))/3;

        cVolume += pyrVolume;
        cVolumePsis =
            tupleBinaryOp
            (
                cVolumePsis,
                tupleBinaryOp
                (
                    tupleOp
                    (
                        tupleOp(fPsis, OpIndex(c[cfi])),
                        OpScaled<scalar>(scalar(3)/scalar(4)*pyrVolume)
                    ),
                    tupleOp
                    (
                        cPsiAvgs,
                        OpScaled<scalar>(scalar(1)/scalar(4)*pyrVolume)
                    ),
                    BinaryOpAdd()
                ),
                BinaryOpAdd()
            );
    }

    return Tuple2<scalar, std::tuple<Types ...>>(cVolume, cVolumePsis);
}


template<class ... Types>
Foam::Tuple2<Foam::scalar, std::tuple<Types ...>>
Foam::cutPoly::cellCutVolumeIntegral
(
    const cell& c,
    const cellEdgeAddressing& cAddr,
    const scalar cVolume,
    const std::tuple<Types ...>& cPsis,
    const labelListList& cCuts,
    const faceUList& fs,
    const vectorField& fAreas,
    const pointField& fCentres,
    const std::tuple<const Field<Types>& ...>& fPsis,
    const vectorField& fCutAreas,
    const std::tuple<const Field<Types>& ...>& fCutPsis,
    const pointField& ps,
    const std::tuple<const Field<Types>& ...>& pPsis,
    const scalarField& pAlphas,
    const scalar isoAlpha,
    const bool below
)
{
    // If there are no cuts return either the entire cell or zero, depending on
    // which side of the iso-surface the cell is
    if (cCuts.size() == 0)
    {
        if ((pAlphas[fs[c[0]][0]] < isoAlpha) == below)
        {
            return
                Tuple2<scalar, std::tuple<Types ...>>
                (
                    cVolume,
                    tupleOp(cPsis, OpScaled<scalar>(cVolume))
                );
        }
        else
        {
            return
                Tuple2<scalar, std::tuple<Types ...>>
                (
                    scalar(0),
                    std::make_tuple(pTraits<Types>::zero ...)
                );
        }
    }

    // Averages
    const point cPAvg = OpIndirectAverage(c)(fCentres);
    auto cPsiAvgs = tupleOp(fPsis, OpIndirectAverage(c));

    // Face contributions. We use the un-cut face's centroid as the base of the
    // pyramid formed by the cut face (see !!! below). This is potentially less
    // exact than using the cut face's centroid, but it is consistent with the
    // un-cut cell volume calculation. This means if you run this function with
    // both values of "below" then the result will exactly sum to the volume of
    // the overall cell. If we used the cut-face's centroid this would not be
    // the case.
    auto result =
        cellVolumeIntegral
        (
            c,
            cAddr,
            cPAvg,
            cPsiAvgs,
            fCutAreas,
            fCentres, // !!!
            fCutPsis
        );

    // Create readably named references to the parts of the result
    scalar& cCutsVolume = result.first();
    std::tuple<Types ...>& cCutsVolumePsis = result.second();

    // Cut contributions
    const cutPoly::CellCutValues<point> cCutPValues
    (
        c,
        cAddr,
        cCuts,
        fs,
        ps,
        pAlphas,
        isoAlpha
    );
    const point cCutPAvg = OpIterableAverage()(cCutPValues);
    auto cCutPsiValues =
        tupleOp
        (
            pPsis,
            OpCellCutValues
            (
                c,
                cAddr,
                cCuts,
                fs,
                pAlphas,
                isoAlpha
            )
        );
    auto cCutPsiAvgs = tupleOp(cCutPsiValues, OpIterableAverage());

    // This method is more exact, as it uses the true centroid of the cell
    // cut. However, to obtain that centroid we have to divide by the area
    // magnitude, so this can't be generalised to types that do not support
    // division.
    const auto cCutAreaPPsis =
        faceAreaAverage
        (
            cCutPValues,
            cCutPAvg,
            std::tuple_cat(std::make_tuple(cCutPValues), cCutPsiValues),
            std::tuple_cat(std::make_tuple(cCutPAvg), cCutPsiAvgs)
        );
    const vector& cCutArea = cCutAreaPPsis.first();
    const vector& cCutCentre = std::get<0>(cCutAreaPPsis.second());
    const auto cCutPsis = tupleTail(cCutAreaPPsis.second());

    /*
    // This method is more approximate, as it uses point averages rather
    // than centroids. This does not involve division, though, so this
    // could be used with types like polynomials that only support addition
    // and multiplication.
    const vector cCutArea =
        faceAreaIntegral
        (
            cCutPValues,
            cCutPAvg,
            std::make_tuple(),
            std::make_tuple()
        ).first();
    const point& cCutCentre = cCutPAvg;
    const auto& cCutPsis = cCutPsiAvgs;
    */

    const scalar pyrVolume =
        (below ? +1 : -1)*(cCutArea & (cCutCentre - cPAvg))/3;

    cCutsVolume += pyrVolume;
    cCutsVolumePsis =
        tupleBinaryOp
        (
            cCutsVolumePsis,
            tupleBinaryOp
            (
                tupleOp
                (
                    cCutPsis,
                    OpScaled<scalar>(scalar(3)/scalar(4)*pyrVolume)
                ),
                tupleOp
                (
                    cPsiAvgs,
                    OpScaled<scalar>(scalar(1)/scalar(4)*pyrVolume)
                ),
                BinaryOpAdd()
            ),
            BinaryOpAdd()
        );

    return result;
}


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