cellQuality.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::cellQuality
26 
27 Description
28  Class calculates cell quality measures.
29 
30 SourceFiles
31  cellQuality.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cellQuality_H
36 #define cellQuality_H
37 
38 #include "polyMesh.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 
46 /*---------------------------------------------------------------------------*\
47  Class cellQuality Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class cellQuality
51 {
52  // Private data
53 
54  //- Reference to mesh
55  const polyMesh& mesh_;
56 
57 
58  // Private Member Functions
59 
60  //- Disallow default bitwise copy construct
61  cellQuality(const cellQuality&);
62 
63  //- Disallow default bitwise assignment
64  void operator=(const cellQuality&);
65 
66 
67 public:
68 
69  // Constructors
70 
71  //- Construct from mesh
72  cellQuality(const polyMesh& mesh);
73 
74 
75  // Destructor - default
76 
77 
78  // Member Functions
79 
80  //- Return cell non-orthogonality
82 
83  //- Return cell skewness
84  tmp<scalarField> skewness() const;
85 
86  //- Return face non-orthogonality
88 
89  //- Return face skewness
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //
Class calculates cell quality measures.
Definition: cellQuality.H:49
dynamicFvMesh & mesh
tmp< scalarField > skewness() const
Return cell skewness.
Definition: cellQuality.C:102
Namespace for OpenFOAM.
tmp< scalarField > nonOrthogonality() const
Return cell non-orthogonality.
Definition: cellQuality.C:40
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
tmp< scalarField > faceNonOrthogonality() const
Return face non-orthogonality.
Definition: cellQuality.C:181
A class for managing temporary objects.
Definition: PtrList.H:118
tmp< scalarField > faceSkewness() const
Return face skewness.
Definition: cellQuality.C:241