polyRemovePoint.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) 2011-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::polyRemovePoint
26 
27 Description
28  Class containing data for point removal.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef polyRemovePoint_H
33 #define polyRemovePoint_H
34 
35 #include "label.H"
36 #include "topoAction.H"
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Class polyRemovePoint Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 class polyRemovePoint
48 :
49  public topoAction
50 {
51  // Private Data
52 
53  //- Point ID
54  label pointID_;
55 
56  //- Merge point ID or -1
57  label mergePointID_;
58 
59 
60 public:
61 
62  // Static Data Members
63 
64  //- Runtime type information
65  TypeName("removePoint");
66 
67 
68  // Constructors
69 
70  //- Construct null. Used for constructing lists
72  :
73  pointID_(-1),
74  mergePointID_(-1)
75  {}
76 
77  //- Construct from components
79  :
80  pointID_(pointID),
81  mergePointID_(mergePointID)
82  {}
83 
84  //- Construct and return a clone
85  virtual autoPtr<topoAction> clone() const
86  {
87  return autoPtr<topoAction>(new polyRemovePoint(*this));
88  }
89 
90 
91  // Default Destructor
92 
93 
94  // Member Functions
95 
96  //- Return point ID
97  label pointID() const
98  {
99  return pointID_;
100  }
102  label mergePointID() const
103  {
104  return mergePointID_;
105  }
106 };
107 
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 } // End namespace Foam
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
label mergePointID() const
TypeName("removePoint")
Runtime type information.
virtual autoPtr< topoAction > clone() const
Construct and return a clone.
A virtual base class for topological actions.
Definition: topoAction.H:48
polyRemovePoint()
Construct null. Used for constructing lists.
label pointID() const
Return point ID.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Class containing data for point removal.
Namespace for OpenFOAM.