src/dynamicMesh/dynamicFvMesh/dynamicTopoFvMesh/tetMetrics/tetMetrics.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM 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 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM 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 OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     tetMetrics
  27
  28 Description
  29     Header file of tetrahedral mesh-quality metrics.
  30
  31 Author
  32     Sandeep Menon
  33     University of Massachusetts Amherst
  34     All rights reserved
  35
  36 SourceFiles
  37     tetMetrics.C
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef tetMetrics_H
  42 #define tetMetrics_H
  43
  44 #include "tetMetric.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Metric Class Declarations
  53 \*---------------------------------------------------------------------------*/
  54
  55 class Knupp
  56 :
  57     public tetMetric
  58 {
  59     // Private Member Functions
  60
  61         //- Disallow default bitwise copy construct
  62         Knupp(const Knupp&);
  63
  64         //- Disallow default bitwise assignment
  65         void operator=(const Knupp&);
  66
  67
  68 public:
  69
  70         //- Runtime type information
  71         TypeName("Knupp");
  72
  73         static scalar metric
  74         (
  75             const point& p0,
  76             const point& p1,
  77             const point& p2,
  78             const point& p3
  79         );
  80
  81
  82     // Destructor
  83
  84         virtual ~Knupp()
  85         {}
  86 };
  87
  88
  89 class Dihedral
  90 :
  91     public tetMetric
  92 {
  93     // Private Member Functions
  94
  95         //- Disallow default bitwise copy construct
  96         Dihedral(const Dihedral&);
  97
  98         //- Disallow default bitwise assignment
  99         void operator=(const Dihedral&);
 100
 101         // Enumeration for tets
 102         static label tetEnum[6][4];
 103
 104
 105 public:
 106
 107         //- Runtime type information
 108         TypeName("Dihedral");
 109
 110         static scalar metric
 111         (
 112             const point& p0,
 113             const point& p1,
 114             const point& p2,
 115             const point& p3
 116         );
 117
 118
 119     // Destructor
 120
 121         virtual ~Dihedral()
 122         {}
 123 };
 124
 125
 126 class cubicMeanRatio
 127 :
 128     public tetMetric
 129 {
 130     // Private Member Functions
 131
 132         //- Disallow default bitwise copy construct
 133         cubicMeanRatio(const cubicMeanRatio&);
 134
 135         //- Disallow default bitwise assignment
 136         void operator=(const cubicMeanRatio&);
 137
 138     public:
 139
 140         //- Runtime type information
 141         TypeName("cubicMeanRatio");
 142
 143         static scalar metric
 144         (
 145             const point& p0,
 146             const point& p1,
 147             const point& p2,
 148             const point& p3
 149         );
 150
 151
 152     // Destructor
 153
 154         virtual ~cubicMeanRatio()
 155         {}
 156 };
 157
 158
 159 class Frobenius
 160 :
 161     public tetMetric
 162 {
 163     // Private Member Functions
 164
 165         //- Disallow default bitwise copy construct
 166         Frobenius(const Frobenius&);
 167
 168         //- Disallow default bitwise assignment
 169         void operator=(const Frobenius&);
 170
 171
 172 public:
 173
 174         //- Runtime type information
 175         TypeName("Frobenius");
 176
 177         static scalar metric
 178         (
 179             const point& p0,
 180             const point& p1,
 181             const point& p2,
 182             const point& p3
 183         );
 184
 185
 186     // Destructor
 187
 188         virtual ~Frobenius()
 189         {}
 190 };
 191
 192
 193 class PGH
 194 :
 195     public tetMetric
 196 {
 197     // Private Member Functions
 198
 199         //- Disallow default bitwise copy construct
 200         PGH(const PGH&);
 201
 202         //- Disallow default bitwise assignment
 203         void operator=(const PGH&);
 204
 205
 206 public:
 207
 208         //- Runtime type information
 209         TypeName("PGH");
 210
 211         static scalar metric
 212         (
 213             const point& p0,
 214             const point& p1,
 215             const point& p2,
 216             const point& p3
 217         );
 218
 219
 220     // Destructor
 221
 222         virtual ~PGH()
 223         {}
 224 };
 225
 226
 227 class CSG
 228 :
 229     public tetMetric
 230 {
 231     // Private Member Functions
 232
 233         //- Disallow default bitwise copy construct
 234         CSG(const CSG&);
 235
 236         //- Disallow default bitwise assignment
 237         void operator=(const CSG&);
 238
 239
 240 public:
 241
 242         //- Runtime type information
 243         TypeName("CSG");
 244
 245         static scalar metric
 246         (
 247             const point& p0,
 248             const point& p1,
 249             const point& p2,
 250             const point& p3
 251         );
 252
 253
 254     // Destructor
 255
 256         virtual ~CSG()
 257         {}
 258 };
 259
 260
 261 } // End namespace Foam
 262
 263 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 264
 265 #endif
 266
 267 // ************************************************************************* //