cellSet.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-2022 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::cellSet
26 
27 Description
28  A collection of cell labels.
29 
30 SourceFiles
31  cellSet.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cellSet_H
36 #define cellSet_H
37 
38 #include "topoSet.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class cellSet Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class cellSet
50 :
51  public topoSet
52 {
53 public:
54 
55  //- Runtime type information
56  TypeName("cellSet");
57 
58 
59  // Constructors
60 
61  //- Construct from IOobject. No checking.
62  cellSet(const IOobject& obj);
63 
64  //- Construct from polyMesh and name. Checks for valid cell ids.
65  cellSet
66  (
67  const polyMesh& mesh,
68  const word& name,
71  );
72 
73  //- Construct empty from size of labelHashSet
74  cellSet
75  (
76  const polyMesh& mesh,
77  const word& name,
78  const label sizes,
80  );
81 
82  //- Construct from existing set
83  cellSet
84  (
85  const polyMesh& mesh,
86  const word& name,
87  const topoSet&,
89  );
90 
91  //- Construct from labelHashSet
92  cellSet
93  (
94  const polyMesh& mesh,
95  const word& name,
96  const labelHashSet&,
98  );
99 
100 
101  // Used for tetMesh cellSet only.
102 
103  //- Construct from objectRegistry and name.
104  cellSet
105  (
106  const Time&,
107  const word& name,
110  );
111 
112  //- Construct empty from objectRegistry.
113  cellSet
114  (
115  const Time&,
116  const word& name,
117  const label size,
119  );
120 
121  //- Construct from labelHashSet
122  cellSet
123  (
124  const Time&,
125  const word& name,
126  const labelHashSet&,
128  );
129 
130  //- Disallow default bitwise copy construction
131  cellSet(const cellSet&) = delete;
132 
133 
134  //- Destructor
135  virtual ~cellSet();
136 
137 
138  // Member Functions
139 
140  //- Sync cellSet across coupled patches.
141  virtual void sync(const polyMesh& mesh)
142  {}
143 
144  //- Return max index+1.
145  virtual label maxSize(const polyMesh& mesh) const;
146 
147  //- Update any stored data for new labels
148  virtual void topoChange(const polyTopoChangeMap& map);
149 
150  //- Write maxLen items with label and coordinates.
151  virtual void writeDebug
152  (
153  Ostream& os,
154  const primitiveMesh&,
155  const label maxLen
156  ) const;
157 };
158 
159 
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 
162 } // End namespace Foam
163 
164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 
166 #endif
167 
168 // ************************************************************************* //
writeOption
Enumeration defining the write options.
Definition: IOobject.H:125
const word & name() const
Return name.
Definition: IOobject.H:315
cellSet(const IOobject &obj)
Construct from IOobject. No checking.
Definition: cellSet.C:48
Cell-face mesh analysis engine.
Definition: primitiveMesh.H:74
virtual void writeDebug(Ostream &os, const primitiveMesh &, const label maxLen) const
Write maxLen items with label and coordinates.
Definition: cellSet.C:232
fvMesh & mesh
readOption
Enumeration defining the read options.
Definition: IOobject.H:116
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:69
label size() const
Return number of elements in table.
Definition: HashTableI.H:65
A class for handling words, derived from string.
Definition: word.H:59
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual void topoChange(const polyTopoChangeMap &map)
Update any stored data for new labels.
Definition: cellSet.C:225
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
TypeName("cellSet")
Runtime type information.
virtual label maxSize(const polyMesh &mesh) const
Return max index+1.
Definition: cellSet.C:219
A collection of cell labels.
Definition: cellSet.H:48
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:76
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:98
virtual ~cellSet()
Destructor.
Definition: cellSet.C:213
virtual void sync(const polyMesh &mesh)
Sync cellSet across coupled patches.
Definition: cellSet.H:140
Namespace for OpenFOAM.