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

Description
    Collection of functions checking primitiveMesh

SourceFiles
    primitiveMeshCheck.C

\*---------------------------------------------------------------------------*/
#ifndef primitiveMeshCheck_H
#define primitiveMeshCheck_H

#include "primitiveMesh.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
                      Namespace meshCheck Declaration
\*---------------------------------------------------------------------------*/

namespace meshCheck
{
    // Topological checks

        //- Check face ordering
        bool checkUpperTriangular
        (
            const primitiveMesh& mesh,
            const bool report = false,
            labelHashSet* setPtr = nullptr
        );

        //- Check cell zip-up
        bool checkCellsZipUp
        (
            const primitiveMesh& mesh,
            const bool report = false,
            labelHashSet* setPtr = nullptr
        );

        //- Check uniqueness of face vertices
        bool checkFaceVertices
        (
            const primitiveMesh& mesh,
            const bool report = false,
            labelHashSet* setPtr = nullptr
        );

        //- Check for unused points
        bool checkPoints
        (
            const primitiveMesh& mesh,
            const bool report = false,
            labelHashSet* setPtr = nullptr
        );

        //- Check if all points on face are shared with another face.
        bool checkDuplicateFaces
        (
            const primitiveMesh& mesh,
            const label,
            const Map<label>&,
            label& nBaffleFaces,
            labelHashSet*
        );

        //- Check that shared points are in consecutive order.
        bool checkCommonOrder
        (
            const primitiveMesh& mesh,
            const label,
            const Map<label>&,
            labelHashSet*
        );

        //- Check face-face connectivity
        bool checkFaceFaces
        (
            const primitiveMesh& mesh,
            const bool report = false,
            labelHashSet* setPtr = nullptr
        );


    // Geometric checks

        //- Generate non-orthogonality field (internal faces only)
        tmp<scalarField> faceOrthogonality
        (
            const primitiveMesh& mesh,
            const vectorField& fAreas,
            const vectorField& cellCtrs
        );

        //- Generate face pyramid volume fields
        void facePyramidVolume
        (
            const primitiveMesh& mesh,
            const pointField& points,
            const vectorField& cellCtrs,
            scalarField& ownPyrVol,
            scalarField& neiPyrVol
        );

        //- Generate skewness field
        tmp<scalarField> faceSkewness
        (
            const primitiveMesh& mesh,
            const pointField& points,
            const vectorField& fCtrs,
            const vectorField& fAreas,
            const vectorField& cellCtrs
        );

        //- Generate cell openness and cell aspect ratio field
        void cellClosedness
        (
            const primitiveMesh& mesh,
            const Vector<label>& meshD,
            const vectorField& areas,
            const scalarField& vols,
            scalarField& openness,
            scalarField& aratio
        );

        //- Generate face concavity field. Returns per face the (sin of the)
        //  most concave angle between two consecutive edges
        tmp<scalarField> faceConcavity
        (
            const scalar maxSin,
            const primitiveMesh& mesh,
            const pointField& p,
            const vectorField& faceAreas
        );

        //- Generate face flatness field. Compares the individual triangles'
        //  normals against the face average normal. Between 0 (fully warped)
        //  and 1 (fully flat)
        tmp<scalarField> faceFlatness
        (
            const primitiveMesh& mesh,
            const pointField& p,
            const vectorField& fCtrs,
            const vectorField& faceAreas
        );

        //- Generate edge alignment field. Is per face the minimum aligned edge
        //  (does not use edge addressing)
        tmp<scalarField> edgeAlignment
        (
            const primitiveMesh& mesh,
            const Vector<label>& directions,
            const pointField& p
        );

        //- Generate cell determinant field
        tmp<scalarField> cellDeterminant
        (
            const primitiveMesh& mesh,
            const Vector<label>& directions,
            const vectorField& faceAreas,
            const PackedBoolList& internalOrCoupledFace
        );


        // Helpers: single face check

            //- Skewness of single face
            scalar faceSkewness
            (
                const primitiveMesh& mesh,
                const pointField& p,
                const vectorField& fCtrs,
                const vectorField& fAreas,

                const label facei,
                const point& ownCc,
                const point& neiCc
            );

            //- Skewness of single boundary face
            scalar boundaryFaceSkewness
            (
                const primitiveMesh& mesh,
                const pointField& p,
                const vectorField& fCtrs,
                const vectorField& fAreas,

                const label facei,
                const point& ownCc
            );

            //- Orthogonality of single face
            scalar faceOrthogonality
            (
                const point& ownCc,
                const point& neiCc,
                const vector& s
            );

        //- Check boundary for closedness
        bool checkClosedBoundary
        (
            const primitiveMesh& mesh,
            const scalar closedThreshold,
            const bool report = false
        );

        //- Check cells for closedness
        bool checkClosedCells
        (
            const primitiveMesh& mesh,
            const scalar closedThreshold,
            const scalar aspectThreshold,
            const bool report = false,
            labelHashSet* setPtr = nullptr,
            labelHashSet* highAspectSetPtr = nullptr,
            const Vector<label>& solutionD = Vector<label>::one
        );

        //- Check for negative face areas
        bool checkFaceAreas
        (
            const primitiveMesh& mesh,
            const bool report = false,
            labelHashSet* setPtr = nullptr
        );

        //- Check for negative cell volumes
        bool checkCellVolumes
        (
            const primitiveMesh& mesh,
            const bool report = false,
            labelHashSet* setPtr = nullptr
        );

        //- Check face pyramid volume
        bool checkFacePyramids
        (
            const primitiveMesh& mesh,
            const bool report = false,
            const scalar minPyrVol = -small,
            labelHashSet* setPtr = nullptr
        );

        //- Check face angles
        bool checkFaceAngles
        (
            const primitiveMesh& mesh,
            const bool report = false,
            const scalar maxSin = 10,    // In degrees
            labelHashSet* setPtr = nullptr
        );

        //- Check face warpage: decompose face and check ratio between
        //  magnitude of sum of triangle areas and sum of magnitude of
        //  triangle areas.
        bool checkFaceFlatness
        (
            const primitiveMesh& mesh,
            const bool report,
            const scalar warnFlatness,  // When to include in set.
            labelHashSet* setPtr
        );

        //- Check for point-point-nearness,
        //  e.g. colocated points which may be part of baffles.
        bool checkPointNearness
        (
            const primitiveMesh& mesh,
            const bool report,
            const scalar reportDistSqr,
            labelHashSet* setPtr = nullptr
        );

        //- Check edge length
        bool checkEdgeLength
        (
            const primitiveMesh& mesh,
            const bool report,
            const scalar minLenSqr,
            labelHashSet* setPtr = nullptr
        );

        //- Check for concave cells by the planes of faces
        bool checkConcaveCells
        (
            const primitiveMesh& mesh,
            const scalar planarCosAngle,
            const bool report = false,
            labelHashSet* setPtr = nullptr
        );
}


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

} // End namespace Foam

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

#endif

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