/
ZoneMesh.H
214 lines (148 loc) · 5.72 KB
/
ZoneMesh.H
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::ZoneMesh
Description
A list of mesh zones.
SourceFiles
ZoneMesh.C
\*---------------------------------------------------------------------------*/
#ifndef ZoneMesh_H
#define ZoneMesh_H
#include "List.H"
#include "regIOobject.H"
#include "pointField.H"
#include "Map.H"
#include "PackedBoolList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Forward declaration of friend functions and operators
template<class ZoneType, class MeshType> class ZoneMesh;
template<class ZoneType, class MeshType>
Ostream& operator<<(Ostream&, const ZoneMesh<ZoneType, MeshType>&);
/*---------------------------------------------------------------------------*\
Class ZoneMesh Declaration
\*---------------------------------------------------------------------------*/
template<class ZoneType, class MeshType>
class ZoneMesh
:
public PtrList<ZoneType>,
public regIOobject
{
// Private data
//- Reference to mesh
const MeshType& mesh_;
//- Map of zone labels for given element
mutable Map<label>* zoneMapPtr_;
// Private Member Functions
//- Read if IOobject flags set. Return true if read.
bool read();
//- Disallow construct as copy
ZoneMesh(const ZoneMesh&);
//- Disallow assignment
void operator=(const ZoneMesh<ZoneType, MeshType>&);
//- Create zone map
void calcZoneMap() const;
public:
// Constructors
//- Read constructor given IOobject and a MeshType reference
ZoneMesh
(
const IOobject&,
const MeshType&
);
//- Construct given size
ZoneMesh
(
const IOobject&,
const MeshType&,
const label size
);
//- Construct given a PtrList
ZoneMesh
(
const IOobject&,
const MeshType&,
const PtrList<ZoneType>&
);
//- Destructor
~ZoneMesh();
// Member Functions
//- Return the mesh reference
const MeshType& mesh() const
{
return mesh_;
}
//- Map of zones containing zone index for all zoned elements
// Return -1 if the object is not in the zone
const Map<label>& zoneMap() const;
//- Given a global object index, return the zone it is in.
// If object does not belong to any zones, return -1
label whichZone(const label objectIndex) const;
//- Return a list of zone types
wordList types() const;
//- Return a list of zone names
wordList names() const;
//- Return zone indices for all matches
labelList findIndices(const keyType&) const;
//- Return zone index for the first match, return -1 if not found
label findIndex(const keyType&) const;
//- Find zone index given a name
label findZoneID(const word& zoneName) const;
//- Mark cells that match the zone specification
PackedBoolList findMatching(const keyType&) const;
//- Clear addressing
void clearAddressing();
//- Clear the zones
void clear();
//- Check zone definition. Return true if in error.
bool checkDefinition(const bool report = false) const;
//- Check whether all procs have all zones and in same order. Return
// true if in error.
bool checkParallelSync(const bool report = false) const;
//- Correct zone mesh after moving points
void movePoints(const pointField&);
//- writeData member function required by regIOobject
bool writeData(Ostream&) const;
// Member Operators
//- Return const and non-const reference to ZoneType by index.
using PtrList<ZoneType>::operator[];
//- Return const reference to ZoneType by name.
const ZoneType& operator[](const word&) const;
//- Return reference to ZoneType by name.
ZoneType& operator[](const word&);
// Ostream operator
friend Ostream& operator<< <ZoneType, MeshType>
(
Ostream&,
const ZoneMesh<ZoneType, MeshType>&
);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "ZoneMesh.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //