src/dynamicMesh/meshMotion/tetMotionSolver/cellQuality/cellQuality.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     cellQuality
  27
  28 Description
  29     Class calculates cell quality measures.
  30
  31 SourceFiles
  32     cellQuality.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef cellQuality_H
  37 #define cellQuality_H
  38
  39 #include "polyMesh.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class cellQuality Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class cellQuality
  52 {
  53     // Private data
  54
  55         //- Reference to mesh
  56         const polyMesh& mesh_;
  57
  58
  59     // Private Member Functions
  60
  61         //- Disallow default bitwise copy construct
  62         cellQuality(const cellQuality&);
  63
  64         //- Disallow default bitwise assignment
  65         void operator=(const cellQuality&);
  66
  67
  68 public:
  69
  70     // Constructors
  71
  72         //- Construct from mesh
  73         cellQuality(const polyMesh& mesh);
  74
  75
  76     // Destructor - default
  77
  78
  79     // Member Functions
  80
  81         //- Return cell non-orthogonality
  82         tmp<scalarField> nonOrthogonality() const;
  83
  84         //- Return cell skewness
  85         tmp<scalarField> skewness() const;
  86
  87         //- Return face non-orthogonality
  88         tmp<scalarField> faceNonOrthogonality() const;
  89
  90         //- Return face skewness
  91         tmp<scalarField> faceSkewness() const;
  92 };
  93
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 } // End namespace Foam
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 #endif
 102
 103 // ************************************************************************* //