Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / mesh / cfMesh / utilities / triSurfaceTools / triSurfaceClassifyEdges / triSurfaceClassifyEdges.H
blob43cc2a082fb5011a5b9afb155d22f3c239a05094
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | cfMesh: A library for mesh generation
4    \\    /   O peration     |
5     \\  /    A nd           | Author: Franjo Juretic (franjo.juretic@c-fields.com)
6      \\/     M anipulation  | Copyright (C) Creative Fields, Ltd.
7 -------------------------------------------------------------------------------
8 License
9     This file is part of cfMesh.
11     cfMesh 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     cfMesh 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.
21     You should have received a copy of the GNU General Public License
22     along with cfMesh.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     triSurfaceClassifyEdges
27 Description
28     Divides the surface mesh into regions bounded by feature edges
30 SourceFiles
31     triSurfaceClassifyEdges.C
32     triSurfaceClassifyEdgesFunctions.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef triSurfaceClassifyEdges_H
37 #define triSurfaceClassifyEdges_H
39 #include "triSurf.H"
40 #include "VRWGraph.H"
41 #include "boolList.H"
42 #include "direction.H"
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 namespace Foam
49 //- Forward declarations
50 class meshOctree;
52 /*---------------------------------------------------------------------------*\
53                 Class triSurfaceClassifyEdges Declaration
54 \*---------------------------------------------------------------------------*/
56 class triSurfaceClassifyEdges
58     // Private data
59         //- reference to meshOctree
60         const meshOctree& octree_;
62         //- flags for surface edges
63         List<direction> edgeTypes_;
65         //- orientation of facet's normal (0 - unknown, 1- outward, 2- inward)
66         List<direction> facetOrientation_;
68     // Private member functions
69         //- check the orientation of the patches in the triangulated surface
70         void checkOrientation();
72         //- classify edges based on the orientation of the surface facets
73         void classifyEdgesTypes();
75         //- Disallow default bitwise copy construct
76         triSurfaceClassifyEdges(const triSurfaceClassifyEdges&);
78         //- Disallow default bitwise assignment
79         void operator=(const triSurfaceClassifyEdges&);
81 public:
83     // Enumerators
85         enum edgeType_
86         {
87             NONE = 0,
88             CONVEXEDGE = 1,
89             CONCAVEEDGE = 2,
90             FLATSURFACEEDGE = 4,
91             FEATUREEDGE = 8
92         };
94     // Constructors
96         //- Construct from octree
97         triSurfaceClassifyEdges(const meshOctree& octree);
99     // Destructor
101         ~triSurfaceClassifyEdges();
104     // Member Functions
106         //- return the edge type according to the above enumerator
107         inline direction edgeType(const label edgeI) const
108         {
109             return edgeTypes_[edgeI];
110         }
112         //- return the list of edge classification
113         const List<direction>& edgeTypes() const;
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 } // End namespace Foam
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 #endif
124 // ************************************************************************* //