File size: 7,580 Bytes
5a600cf | 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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2025-2026 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::zoneSet
Description
Zone container returned by zoneGenerator::generate
Optionally contains any combination of point, cell or face zones generated
by the zoneGenerator::generate function which may simply be the zones
returned by a lookup from the lists of zones stored on the mesh or generated
by the particular \c zoneGenerator from a geometric search for example.
Having \c zoneSet optionally hold zones of more than one type is
particularly useful for the generation of complex coupled or related zone
systems, for example rotating regions requiring both the \c cellZone of the
rotating cells and the faces of the outer moving/sliding boundary.
SourceFiles
zoneSetI.H
zoneSet.C
See also
Foam::zoneGenerator
\*---------------------------------------------------------------------------*/
#ifndef zoneSet_H
#define zoneSet_H
#include "NamedEnum.H"
#include "tmpNrc.H"
#include "pointZone.H"
#include "cellZone.H"
#include "faceZone.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- Enumeration defining the zone types
enum class zoneTypes
{
point,
cell,
face
};
//- Named enumeration defining the zone type names
extern const NamedEnum<zoneTypes, 3> zoneTypesNames;
//- Enumeration defining the zone types with an option for all the types
enum class zoneTypesAll
{
point,
cell,
face,
all
};
//- Named enumeration defining the zone type names
// with an option for all the types
extern const NamedEnum<zoneTypesAll, 4> zoneTypesAllNames;
/*---------------------------------------------------------------------------*\
Class zoneSet Declaration
\*---------------------------------------------------------------------------*/
class zoneSet
{
// Private Data
//- Temporary pointZone
tmpNrc<pointZone> pZone_;
//- Temporary cellZone
tmpNrc<cellZone> cZone_;
//- Temporary faceZone
tmpNrc<faceZone> fZone_;
// Private Member Functions
//- Print to FatalError the names of all the types zones allocated
template<class ZoneType>
void checkValid(const tmpNrc<ZoneType>& zone) const;
public:
// Constructors
//- Construct null
inline zoneSet();
//- Construct copy transferring content of temporaries
inline zoneSet(const zoneSet&);
//- Construct copy moving content
inline zoneSet(zoneSet&&) = default;
//- Construct from pointZone pointer
inline zoneSet(pointZone* pointZonePtr);
//- Construct from cellZone pointer
inline zoneSet(cellZone* cellZonePtr);
//- Construct from faceZone pointer
inline zoneSet(faceZone* faceZonePtr);
//- Construct from pointZone, cellZone and faceZone pointers
inline zoneSet
(
pointZone* pointZonePtr,
cellZone* cellZonePtr,
faceZone* faceZonePtr
);
//- Construct from pointZone
inline zoneSet(const pointZone& pointZoneRef);
//- Construct from cellZone
inline zoneSet(const cellZone& cellZoneRef);
//- Construct from faceZone
inline zoneSet(const faceZone& faceZoneRef);
//- Construct copy transferring content of temporaries if required
inline zoneSet(const zoneSet&, bool allowTransfer);
//- Construct and return a clone with a new name
inline zoneSet clone(const word& name) const;
// Member Functions
//- Return true if the pointZone is allocated
inline bool pValid() const;
//- Return true if the cellZone is allocated
inline bool cValid() const;
//- Return true if the faceZone is allocated
inline bool fValid() const;
//- Return true if any of the zone types are allocated
inline bool valid() const;
//- Return true if the zone type specified by template specialisation
// is allocated
template<class ZoneType>
inline bool valid() const;
//- Return a reference to the pointZone if allocated
// otherwise stop with an error
inline const pointZone& pZone() const;
//- Return a reference to the cellZone if allocated
// otherwise stop with an error
inline const cellZone& cZone() const;
//- Return a reference to the faceZone if allocated
// otherwise stop with an error
inline const faceZone& fZone() const;
//- Return a reference to the zone type
// specified by template specialisation if allocated
// otherwise stop with an error
template<class ZoneType>
inline const ZoneType& zone() const;
//- Store the temporary zones and return the stored zoneSet
zoneSet store() const;
// Member Operators
//- Assignment transferring the temporary zones
void operator=(const zoneSet&);
//- Assignment moving content
inline zoneSet& operator=(zoneSet&&) = default;
//- Assignment to pointZone, updating pZone_
inline void operator=(const pointZone&);
//- Assignment to cellZone, updating cZone_
inline void operator=(const cellZone&);
//- Assignment to faceZone, updating fZone_
inline void operator=(const faceZone&);
};
template<>
inline bool zoneSet::valid<pointZone>() const;
template<>
inline bool zoneSet::valid<cellZone>() const;
template<>
inline bool zoneSet::valid<faceZone>() const;
template<>
inline const pointZone& zoneSet::zone<pointZone>() const;
template<>
inline const cellZone& zoneSet::zone<cellZone>() const;
template<>
inline const faceZone& zoneSet::zone<faceZone>() const;
template<class ZoneType>
inline zoneTypes zoneType();
template<>
inline zoneTypes zoneType<pointZone>();
template<>
inline zoneTypes zoneType<cellZone>();
template<>
inline zoneTypes zoneType<faceZone>();
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "zoneSetI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|