src/mesh/cfMesh/meshLibrary/utilities/meshes/polyMeshGenChecks/polyMeshGenChecks.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | cfMesh: A library for mesh generation
   4    \\    /   O peration     |
   5     \\  /    A nd           | Author: Franjo Juretic (franjo.juretic@c-fields.com)
   6      \\/     M anipulation  | Copyright (C) Creative Fields, Ltd.
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of cfMesh.
  10
  11     cfMesh is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     cfMesh is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with cfMesh.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     polyMeshGenChecks
  26
  27 Description
  28     A set of functions used for mesh checking mesh quality
  29
  30 SourceFiles
  31     polyMeshGenAddressingChecks.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef polyMeshGenChecks_H
  36 #define polyMeshGenChecks_H
  37
  38 #include "polyMeshGen.H"
  39 #include "boolList.H"
  40 #include "HashSet.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48             Namespace polyMeshGenChecks functions Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 namespace polyMeshGenChecks
  52 {
  53
  54 // Check geometry
  55 //- Check boundary closedness
  56 bool checkClosedBoundary(const polyMeshGen&, const bool report = false);
  57
  58 //- Check cells for closedness
  59 bool checkClosedCells
  60 (
  61     const polyMeshGen&,
  62     const bool report = false,
  63     const scalar aspectWarn = 1000,
  64     labelHashSet* setPtr = NULL
  65 );
  66
  67 //- Check for negative cell volumes
  68 bool checkCellVolumes
  69 (
  70     const polyMeshGen&,
  71     const bool report = false,
  72     labelHashSet* setPtr = NULL
  73 );
  74
  75 //- Check for negative face areas
  76 bool checkFaceAreas
  77 (
  78     const polyMeshGen&,
  79     const bool report = false,
  80     const scalar minFaceArea = VSMALL,
  81     labelHashSet* setPtr = NULL,
  82     const boolList* changedFacePtr = NULL
  83 );
  84
  85 //- Check for negative part tetrahedra
  86 //- Cells are decomposed into tetrahedra formed by
  87 //- the cell centre, face centre and the edge vertices
  88 bool checkCellPartTetrahedra
  89 (
  90     const polyMeshGen&,
  91     const bool report = false,
  92     const scalar minPartTet = VSMALL,
  93     labelHashSet* setPtr = NULL,
  94     const boolList* changedFacePtr = NULL
  95 );
  96
  97 //- Check for non-orthogonality
  98 bool checkFaceDotProduct
  99 (
 100     const polyMeshGen&,
 101     const bool report = false,
 102     const scalar nonOrthWarn = 70.0,
 103     labelHashSet* setPtr = NULL,
 104     const boolList* changedFacePtr = NULL
 105 );
 106
 107 //- Check face pyramid volume
 108 bool checkFacePyramids
 109 (
 110     const polyMeshGen&,
 111     const bool report = false,
 112     const scalar minPyrVol = -SMALL,
 113     labelHashSet* setPtr = NULL,
 114     const boolList* changedFacePtr = NULL
 115 );
 116
 117 //- Check face skewness
 118 bool checkFaceSkewness
 119 (
 120     const polyMeshGen&,
 121     const bool report = false,
 122     const scalar warnSkew = 4.0,
 123     labelHashSet* setPtr = NULL,
 124     const boolList* changedFacePtr = NULL
 125 );
 126
 127 //- Check face uniformity
 128 bool checkFaceUniformity
 129 (
 130     const polyMeshGen&,
 131     const bool report = false,
 132     const scalar warnUniform = 0.1,
 133     labelHashSet* setPtr = NULL,
 134     const boolList* changedFacePtr = NULL
 135 );
 136
 137 //- Check face angles
 138 bool checkFaceAngles
 139 (
 140     const polyMeshGen&,
 141     const bool report = false,
 142     const scalar maxDeg = 10,    // In degrees
 143     labelHashSet* setPtr = NULL,
 144     const boolList* changedFacePtr = NULL
 145 );
 146
 147 //- Check face warpage: decompose face and check ratio between
 148 //  magnitude of sum of triangle areas and sum of magnitude of
 149 //  triangle areas.
 150 bool checkFaceFlatness
 151 (
 152     const polyMeshGen&,
 153     const bool report,
 154     const scalar warnFlatness,  // When to include in set.
 155     labelHashSet* setPtr,
 156     const boolList* changedFacePtr = NULL
 157 );
 158
 159 // Checks using topology only
 160
 161 //- Check for unused points
 162 bool checkPoints
 163 (
 164     const polyMeshGen&,
 165     const bool report = false,
 166     labelHashSet* setPtr = NULL
 167 );
 168
 169 //- Check face ordering
 170 bool checkUpperTriangular
 171 (
 172     const polyMeshGen&,
 173     const bool report = false,
 174     labelHashSet* setPtr = NULL
 175 );
 176
 177 //- Check cell zip-up
 178 bool checkCellsZipUp
 179 (
 180     const polyMeshGen&,
 181     const bool report = false,
 182     labelHashSet* setPtr = NULL
 183 );
 184
 185 //- Check uniqueness of face vertices
 186 bool checkFaceVertices
 187 (
 188     const polyMeshGen&,
 189     const bool report = false,
 190     labelHashSet* setPtr = NULL
 191 );
 192
 193 //- Check mesh topology for correctness. Returns false for no error.
 194 bool checkTopology(const polyMeshGen&, const bool report = false);
 195
 196 //- Check mesh geometry (& implicitly topology) for correctness.
 197 //  Returns false for no error.
 198 bool checkGeometry(const polyMeshGen&, const bool report = false);
 199
 200 //- Check mesh for correctness. Returns false for no error.
 201 bool checkMesh(const polyMeshGen&, const bool report = false);
 202 }
 203
 204 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 205
 206 } // End namespace Foam
 207
 208 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 209
 210 #endif
 211
 212 // ************************************************************************* //