polyModifyCell.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011 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::polyModifyCell
26 
27 Description
28  Class describing modification of a cell.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef polyModifyCell_H
33 #define polyModifyCell_H
34 
35 #include "label.H"
36 #include "topoAction.H"
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Class polyModifyCell Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 class polyModifyCell
48 :
49  public topoAction
50 {
51  // Private data
52 
53  //- Cell ID
54  label cellID_;
55 
56  //- Remove from current zone
57  bool removeFromZone_;
58 
59  //- New zone ID
60  label zoneID_;
61 
62 
63 public:
64 
65  // Static data members
66 
67  //- Runtime type information
68  TypeName("modifyCell");
69 
70 
71  // Constructors
72 
73  //- Construct null. Used only for list construction
75  :
76  cellID_(-1),
77  removeFromZone_(false),
78  zoneID_(-1)
79  {}
80 
81  //- Construct from components
83  (
84  const label cellID,
85  const bool removeFromZone,
86  const label newZoneID
87  )
88  :
89  cellID_(cellID),
90  removeFromZone_(removeFromZone),
91  zoneID_(newZoneID)
92  {}
93 
94  //- Construct and return a clone
95  virtual autoPtr<topoAction> clone() const
96  {
97  return autoPtr<topoAction>(new polyModifyCell(*this));
98  }
99 
100 
101  // Default Destructor
102 
103  // Member Functions
104 
105  //- Cell ID
106  label cellID() const
107  {
108  return cellID_;
109  }
110 
111  //- Does the cell belong to a zone?
112  bool isInZone() const
113  {
114  return zoneID_ >= 0;
115  }
117  bool removeFromZone() const
118  {
119  return removeFromZone_;
120  }
121 
122  //- Cell zone ID
123  label zoneID() const
124  {
125  return zoneID_;
126  }
127 };
128 
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 } // End namespace Foam
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 #endif
137 
138 // ************************************************************************* //
virtual autoPtr< topoAction > clone() const
Construct and return a clone.
bool removeFromZone() const
A virtual base class for topological actions.
Definition: topoAction.H:48
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Namespace for OpenFOAM.
polyModifyCell()
Construct null. Used only for list construction.
label zoneID() const
Cell zone ID.
label cellID() const
Cell ID.
TypeName("modifyCell")
Runtime type information.
Class describing modification of a cell.
bool isInZone() const
Does the cell belong to a zone?
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117