cellZoneSet.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::cellZoneSet
26 
27 Description
28  Like cellSet but updates cellZone when writing.
29 
30 SourceFiles
31  cellZone.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cellZoneSet_H
36 #define cellZoneSet_H
37 
38 #include "cellSet.H"
39 #include "boolList.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class cellZoneSet Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class cellZoneSet
51 :
52  public cellSet
53 {
54  // Private data
55 
56  const polyMesh& mesh_;
57 
58  labelList addressing_;
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("cellZoneSet");
64 
65 
66  // Constructors
67 
68  //- Construct from objectRegistry and name
70  (
71  const polyMesh& mesh,
72  const word& name,
75  );
76 
77  //- Construct from additional size of labelHashSet
79  (
80  const polyMesh& mesh,
81  const word& name,
82  const label,
84  );
85 
86  //- Construct from existing set
88  (
89  const polyMesh& mesh,
90  const word& name,
91  const topoSet&,
93  );
94 
95 
96 
97  //- Destructor
98  virtual ~cellZoneSet();
99 
100 
101  // Member functions
103  const labelList& addressing() const
104  {
105  return addressing_;
106  }
109  {
110  return addressing_;
111  }
112 
113  //- Sort addressing and make cellSet part consistent with addressing
114  void updateSet();
115 
116  //- Invert contents. (insert all members 0..maxLen-1 which were not in
117  // set)
118  virtual void invert(const label maxLen);
119 
120  //- Subset contents. Only elements present in both sets remain.
121  virtual void subset(const topoSet& set);
122 
123  //- Add elements present in set.
124  virtual void addSet(const topoSet& set);
125 
126  //- Delete elements present in set.
127  virtual void deleteSet(const topoSet& set);
128 
129  //- Sync cellZoneSet across coupled patches.
130  virtual void sync(const polyMesh& mesh);
131 
132  //- Write maxLen items with label and coordinates.
133  virtual void writeDebug
134  (
135  Ostream& os,
136  const primitiveMesh&,
137  const label maxLen
138  ) const;
139 
140  //- Write cellZone
141  virtual bool writeObject
142  (
146  ) const;
147 
148  //- Update any stored data for new labels
149  virtual void updateMesh(const mapPolyMesh& morphMap);
150 
151  //- Return max index+1.
152  virtual label maxSize(const polyMesh& mesh) const;
153 
154 
155 
156 
157 };
158 
159 
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 
162 } // End namespace Foam
163 
164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 
166 #endif
167 
168 // ************************************************************************* //
const labelList & addressing() const
Definition: cellZoneSet.H:102
virtual void subset(const topoSet &set)
Subset contents. Only elements present in both sets remain.
Definition: cellZoneSet.C:167
Like cellSet but updates cellZone when writing.
Definition: cellZoneSet.H:49
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Definition: mapPolyMesh.H:158
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
A collection of cell labels.
Definition: cellSet.H:48
A class for handling words, derived from string.
Definition: word.H:59
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
virtual bool writeObject(IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
Write cellZone.
Definition: cellZoneSet.C:243
dynamicFvMesh & mesh
Namespace for OpenFOAM.
void updateSet()
Sort addressing and make cellSet part consistent with addressing.
Definition: cellZoneSet.C:48
Cell-face mesh analysis engine.
Definition: primitiveMesh.H:74
virtual void addSet(const topoSet &set)
Add elements present in set.
Definition: cellZoneSet.C:188
streamFormat
Enumeration for the format of data in the stream.
Definition: IOstream.H:86
readOption
Enumeration defining the read options.
Definition: IOobject.H:106
virtual void updateMesh(const mapPolyMesh &morphMap)
Update any stored data for new labels.
Definition: cellZoneSet.C:286
virtual void writeDebug(Ostream &os, const primitiveMesh &, const label maxLen) const
Write maxLen items with label and coordinates.
Definition: cellZoneSet.C:311
const word & name() const
Return name.
Definition: IOobject.H:260
virtual label maxSize(const polyMesh &mesh) const
Return max index+1.
Definition: cellZoneSet.C:235
compressionType
Enumeration for the format of data in the stream.
Definition: IOstream.H:193
cellZoneSet(const polyMesh &mesh, const word &name, readOption r=MUST_READ, writeOption w=NO_WRITE)
Construct from objectRegistry and name.
Definition: cellZoneSet.C:66
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
virtual void deleteSet(const topoSet &set)
Delete elements present in set.
Definition: cellZoneSet.C:209
writeOption
Enumeration defining the write options.
Definition: IOobject.H:115
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
virtual ~cellZoneSet()
Destructor.
Definition: cellZoneSet.C:131
virtual void invert(const label maxLen)
Invert contents. (insert all members 0..maxLen-1 which were not in.
Definition: cellZoneSet.C:137
TypeName("cellZoneSet")
Runtime type information.
Version number type.
Definition: IOstream.H:96
virtual void sync(const polyMesh &mesh)
Sync cellZoneSet across coupled patches.
Definition: cellZoneSet.C:231