Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / applications / utilities / mesh / advanced / selectCells / edgeStats.H
blob92994de9fc154544911fdab88e4e8eca75e0df18
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend 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.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::edgeStats
27 Description
28     Helper class to calculate minimum edge length on mesh.
30 SourceFiles
31     edgeStats.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef edgeStats_H
36 #define edgeStats_H
38 #include "direction.H"
39 #include "scalar.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 // Forward declaration of classes
47 class polyMesh;
48 class Ostream;
49 class twoDPointCorrector;
51 /*---------------------------------------------------------------------------*\
52                            Class edgeStats Declaration
53 \*---------------------------------------------------------------------------*/
55 class edgeStats
57     // Private data
59         //- Reference to mesh.
60         const polyMesh& mesh_;
62         //- Component (0,1,2) of normal direction or 3 if 3D case.
63         direction normalDir_;
65     // Private Member Functions
67         //- If 2d get component of normal dir.
68         direction getNormalDir(const twoDPointCorrector*) const;
71         //- Disallow default bitwise copy construct
72         edgeStats(const edgeStats&);
74         //- Disallow default bitwise assignment
75         void operator=(const edgeStats&);
78 public:
80     // Static data members
82         // Max (cos of) angle for edges to be considered aligned with axis.
83         static const scalar edgeTol_;
86     // Constructors
88         //- Construct from mesh
89         edgeStats(const polyMesh& mesh);
91         //- Construct from mesh and corrector
92         edgeStats(const polyMesh& mesh, const twoDPointCorrector* );
95     // Member Functions
97         //- Calculate minimum edge length and print
98         scalar minLen(Ostream& os) const;
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 } // End namespace Foam
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 #endif
110 // ************************************************************************* //