pointFeatureEdgesTypes.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2012-2019 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::pointFeatureEdgesTypes
26 
27 Description
28  Holds information on the types of feature edges attached to feature points.
29 
30 SourceFiles
31  pointFeatureEdgesTypes.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef pointFeatureEdgesTypes_H
36 #define pointFeatureEdgesTypes_H
37 
38 #include "HashTable.H"
40 #include "List.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 // Forward declaration of friend functions and operators
48 
49 class pointFeatureEdgesTypes;
50 
51 Ostream& operator<<(Ostream&, const pointFeatureEdgesTypes&);
52 
53 
54 /*---------------------------------------------------------------------------*\
55  Class pointFeatureEdgesTypes Declaration
56 \*---------------------------------------------------------------------------*/
57 
58 //- Hold the types of feature edges attached to the point.
60 :
61  public HashTable<label, extendedFeatureEdgeMesh::edgeStatus>
62 {
63  // Private Data
64 
65  //- Reference to the feature edge mesh
66  const extendedFeatureEdgeMesh& feMesh_;
67 
68  //- Label of the point
69  label pointLabel_;
70 
71 
72 public:
73 
74  // Constructors
75 
76  //- Construct from components
78  (
79  const extendedFeatureEdgeMesh& feMesh,
80  const label pointLabel
81  );
82 
83 
84  //- Destructor
86 
87 
88  // Member Functions
89 
90  //- Fill the pointFeatureEdgesType class with the types of feature
91  // edges that are attached to the point.
93 
94 
95  // Info
96 
97  friend Ostream& operator<<
98  (
99  Ostream& os,
101  );
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace Foam
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************************************************************* //
pointFeatureEdgesTypes(const extendedFeatureEdgeMesh &feMesh, const label pointLabel)
Construct from components.
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
Hold the types of feature edges attached to the point.
An STL-conforming hash table.
Definition: HashTable.H:61
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
~pointFeatureEdgesTypes()
Destructor.
Ostream & operator<<(Ostream &, const ensightPart &)
volScalarField & p
Namespace for OpenFOAM.
List< extendedFeatureEdgeMesh::edgeStatus > calcPointFeatureEdgesTypes()
Fill the pointFeatureEdgesType class with the types of feature.