edgeStats.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::edgeStats
26 
27 Description
28  Helper class to calculate minimum edge length on mesh.
29 
30 SourceFiles
31  edgeStats.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef edgeStats_H
36 #define edgeStats_H
37 
38 #include "direction.H"
39 #include "scalar.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // Forward declaration of classes
47 class polyMesh;
48 class Ostream;
49 class twoDPointCorrector;
50 
51 /*---------------------------------------------------------------------------*\
52  Class edgeStats Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class edgeStats
56 {
57  // Private data
58 
59  //- Reference to mesh.
60  const polyMesh& mesh_;
61 
62  //- Component (0,1,2) of normal direction or 3 if 3D case.
63  direction normalDir_;
64 
65  // Private Member Functions
66 
67  //- If 2d get component of normal dir.
68  direction getNormalDir(const twoDPointCorrector*) const;
69 
70 
71  //- Disallow default bitwise copy construct
72  edgeStats(const edgeStats&);
73 
74  //- Disallow default bitwise assignment
75  void operator=(const edgeStats&);
76 
77 
78 public:
79 
80  // Static data members
81 
82  // Max (cos of) angle for edges to be considered aligned with axis.
83  static const scalar edgeTol_;
84 
85 
86  // Constructors
87 
88  //- Construct from mesh
89  edgeStats(const polyMesh& mesh);
90 
91  //- Construct from mesh and corrector
92  edgeStats(const polyMesh& mesh, const twoDPointCorrector* );
93 
94 
95  // Member Functions
96 
97  //- Calculate minimum edge length and print
98  scalar minLen(Ostream& os) const;
99 };
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
uint8_t direction
Definition: direction.H:46
static const scalar edgeTol_
Definition: edgeStats.H:82
dynamicFvMesh & mesh
Class applies a two-dimensional correction to mesh motion point field.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
Direction is an 8-bit unsigned integer type used to represent the Cartesian directions etc...
Helper class to calculate minimum edge length on mesh.
Definition: edgeStats.H:54
scalar minLen(Ostream &os) const
Calculate minimum edge length and print.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Namespace for OpenFOAM.