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