File size: 11,599 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
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2022-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/>.

Namespace
    Foam::cutPoly

Description
    Functions and classes for extracting values from cut edges, faces and cells

SourceFiles
    cutPolyValueI.H
    cutPolyValueTemplates.C

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

#ifndef cutPolyValue_H
#define cutPolyValue_H

#include "cutPoly.H"

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

namespace Foam
{
namespace cutPoly
{

//- Get the local coordinate within an edge, given end point values and an
//  iso-value
inline scalar edgeCutLambda
(
    const edge& e,
    const scalarField& pAlphas,
    const scalar isoAlpha
);

//- Linearly interpolate a value from the end points to the cut point of an
//  edge, given a local coordinate within the edge
template<class Type>
Type edgeCutValue
(
    const edge& e,
    const scalar lambda,
    const Field<Type>& pPsis
);

//- Linearly interpolate a value from the end points to the cut point of an
//  edge, given end point values and an iso-value
template<class Type>
Type edgeCutValue
(
    const edge& e,
    const scalarField& pAlphas,
    const scalar isoAlpha,
    const Field<Type>& pPsis
);


/*---------------------------------------------------------------------------*\
                       Class FaceValues Declaration
\*---------------------------------------------------------------------------*/

template<class Type>
class FaceValues
{
    // Private Data

        //- The face
        const face& f_;

        //- The point values that we want to iterate over
        const Field<Type>& pPsis_;


public:

    // Public Typedefs

        //- The value type
        typedef Type value_type;


    // Public Classes

        //- Forward iterator
        class const_iterator
        {
            // Private Data

                //- Reference to the face-values
                const FaceValues<Type>& fValues_;

                //- Index of the face-point
                label i_;


        public:

            // Constructors

                //- Construct from components
                const_iterator(const FaceValues<Type>& fValues, const label i);


            // Member Functions

                //- Get the next value around the sub-face
                Type next() const;


            // Member Operators

                //- Equality comparison
                bool operator==(const const_iterator& it) const;

                //- Inequality comparison
                bool operator!=(const const_iterator& it) const;

                //- Dereference
                Type operator*() const;

                //- Increment
                inline const_iterator& operator++();

                //- Increment
                inline const_iterator operator++(int);
        };


    // Constructors

        //- Construct from components
        FaceValues(const face& f, const Field<Type>& pPsis);


    // Member Functions

        //- Get the beginning of the iteration over the values
        const_iterator begin() const;

        //- Get the end of the iteration over the values
        const_iterator end() const;

        //- Get the beginning of the iteration over the values
        const_iterator cbegin() const;

        //- Get the end of the iteration over the values
        const_iterator cend() const;
};


/*---------------------------------------------------------------------------*\
                       Class FaceCutValues Declaration
\*---------------------------------------------------------------------------*/

template<class Type>
class FaceCutValues
{
    // Private Data

        //- The face
        const face& f_;

        //- The face's cuts
        const List<labelPair>& fCuts_;

        //- The point values that we want to iterate over
        const Field<Type>& pPsis_;

        //- The point values that define the iso-surface
        const scalarField& pAlphas_;

        //- The value that defines the iso-surface
        const scalar isoAlpha_;

        //- Do we want to iterate over the cut below or above the iso surface?
        const bool below_;


public:

    // Public Typedefs

        //- The value type
        typedef Type value_type;


    // Public Classes

        //- Forward iterator
        class const_iterator
        {
            // Private Data

                //- Reference to the face-values
                const FaceCutValues<Type>& fValues_;

                //- Index of the sub-face and sub-face-point
                label i_, j_;

                //- Cache of values on cut edges for this sub-face segment
                mutable Tuple2<label, Pair<Type>> iAndCutPsis_;


            // Private Member Functions

                //- Get the values on the cut edges for this sub-face segment
                const Pair<Type>& cutPsis(const label i) const;

                //- Return the size of the given sub-face
                label size(const label i) const;

                //- Return the value for the given sub-face and sub-face-point
                const Type psi(const label i, const label j) const;


        public:

            // Constructors

                //- Construct from components
                const_iterator
                (
                    const FaceCutValues<Type>& fValues,
                    const label i,
                    const label j
                );


            // Member Functions

                //- Get the next value around the sub-face
                Type next() const;


            // Member Operators

                //- Equality comparison
                bool operator==(const const_iterator& it) const;

                //- Inequality comparison
                bool operator!=(const const_iterator& it) const;

                //- Dereference
                Type operator*() const;

                //- Increment
                inline const_iterator& operator++();

                //- Increment
                inline const_iterator operator++(int);
        };


    // Constructors

        //- Construct from components
        FaceCutValues
        (
            const face& f,
            const List<labelPair>& fCuts,
            const Field<Type>& pPsis,
            const scalarField& pAlphas,
            const scalar isoAlpha,
            const bool below
        );


    // Member Functions

        //- Get the beginning of the iteration over the values
        const_iterator begin() const;

        //- Get the end of the iteration over the values
        const_iterator end() const;

        //- Get the beginning of the iteration over the values
        const_iterator cbegin() const;

        //- Get the end of the iteration over the values
        const_iterator cend() const;
};


/*---------------------------------------------------------------------------*\
                       Class CellCutValues Declaration
\*---------------------------------------------------------------------------*/

template<class Type>
class CellCutValues
{
    // Private Data

        //- The cell
        const cell& c_;

        //- The cell's edge addressing
        const cellEdgeAddressing& cAddr_;

        //- The cell's cuts
        const labelListList& cCuts_;

        //- The faces
        const faceList& fs_;

        //- The point values that we want to iterate over
        const Field<Type>& pPsis_;

        //- The point values that define the iso-surface
        const scalarField& pAlphas_;

        //- The value that defines the iso-surface
        const scalar isoAlpha_;


public:

    // Public Typedefs

        //- The value type
        typedef Type value_type;


    // Public Classes

        //- Forward iterator
        class const_iterator
        {
            // Private Data

                //- Reference to the cell-values
                const CellCutValues<Type>& cValues_;

                //- Index of the loop and loop-point
                label i_, j_;


            // Private Member Functions

                //- The values at this loop-point and the next
                Pair<Type> psis_;

                //- Return the value for the given loop and loop-point
                Type psi(const label i, const label j);


        public:

            // Constructors

                //- Construct from components
                const_iterator
                (
                    const CellCutValues<Type>& cValues,
                    const label i,
                    const label j
                );


            // Member Functions

                //- Get the next value around the loop
                const Type& next() const;


            // Member Operators

                //- Equality comparison
                bool operator==(const const_iterator& it) const;

                //- Inequality comparison
                bool operator!=(const const_iterator& it) const;

                //- Dereference
                const Type& operator*() const;

                //- Increment
                inline const_iterator& operator++();

                //- Increment
                inline const_iterator operator++(int);
        };


    // Constructors

        //- Construct from components
        CellCutValues
        (
            const cell& c,
            const cellEdgeAddressing& cAddr,
            const labelListList& cCuts,
            const faceList& fs,
            const Field<Type>& pPsis,
            const scalarField& pAlphas,
            const scalar isoAlpha
        );


    // Member Functions

        //- Get the beginning of the iteration over the values
        const_iterator begin() const;

        //- Get the end of the iteration over the values
        const_iterator end() const;

        //- Get the beginning of the iteration over the values
        const_iterator cbegin() const;

        //- Get the end of the iteration over the values
        const_iterator cend() const;
};

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

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

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

#include "cutPolyValueI.H"

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

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

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

#endif

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