File size: 9,300 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 268 269 270 271 272 273 274 275 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2021-2023 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::star
Description
Engine for constructing a star-shaped domain by walking
SourceFiles
star.C
\*---------------------------------------------------------------------------*/
#ifndef star_H
#define star_H
#include "DynamicList.H"
#include "labelPair.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class star Declaration
\*---------------------------------------------------------------------------*/
class star
{
public:
// Public Classes
//- Star-edge structure. Poor man's linked list link.
struct edgeLink
{
label starEdgei0_;
label edgei_;
label starEdgei1_;
};
//- Context class. Returned by populate and resets the star when it
// goes out of scope.
class context
{
private:
// Private Data
//- Reference to the star
star& star_;
public:
// Constructors
//- Construct from components
context(star& s);
// Destructor
~context();
};
private:
// Private Data
//- For each star face, the external face index, or -1
DynamicList<label> starFaceFaces_;
//- For each external face, the star face index, or -1
DynamicList<label> faceStarFaces_;
//- For each star edge, the external edge index and the two adjacent
// star indices, or {-1, -1, -1}
DynamicList<edgeLink> starEdgeEdges_;
//- For each external edge, the star edge index, or -1
DynamicList<label> edgeStarEdges_;
//- Generic work array
DynamicList<label> work_;
// Private Member Functions
//- Reset the contents of the star, ready for another populate
void reset();
//- Swap the given star edges. The star connectivity remains the same.
// Used to change order of iteration.
void swapStarEdges(const label starEdgeiA, const label starEdgeiB);
//- Expand the star by crossing a given edge into a given face
template<class FaceEdges>
void cross
(
const label edgei,
const label facei,
const UList<FaceEdges>& faceEdges
);
public:
// Constructors
//- Construct null
star();
// Destructor
~star();
// Member Functions
// Access
//- Access the star-face-faces
const DynamicList<label>& starFaceFaces() const
{
return starFaceFaces_;
}
//- Access the face-star-faces
const DynamicList<label>& faceStarFaces() const
{
return faceStarFaces_;
}
//- Access the star-edge-edges
const DynamicList<edgeLink>& starEdgeEdges() const
{
return starEdgeEdges_;
}
//- Access the edge-star-edges
const DynamicList<label>& edgeStarEdges() const
{
return edgeStarEdges_;
}
//- Populate the star given a seed face or edge, a function
// `canCross(edgei, facei)` to determine whether an edge may be cross,
// and face-edge and edge-face addressing. After this is called, the
// forAll... macros below can be user to iterate through the star
// faces, or around the edges of the star perimeter.
template<class CanCross, class FaceEdges>
context populate
(
const label faceOrEdgei,
const bool isFace,
CanCross canCross,
const UList<FaceEdges>& faceEdges,
const UList<labelPair>& edgeFaces,
const label maxIterations = labelMax
);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
inline bool operator==(const star::edgeLink& elA, const star::edgeLink& elB)
{
return
elA.starEdgei0_ == elB.starEdgei0_
&& elA.edgei_ == elB.edgei_
&& elA.starEdgei1_ == elB.starEdgei1_;
}
inline bool operator!=(const star::edgeLink& elA, const star::edgeLink& elB)
{
return !(elA == elB);
}
inline Ostream& operator<<(Ostream& os, const star::edgeLink& el)
{
return os
<< '(' << el.starEdgei0_ << ')'
<< ' ' << el.edgei_ << ' '
<< '(' << el.starEdgei1_ << ')';
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#define forAllStarFaces(star, starFacei, facei) \
for \
( \
label starFacei = 0, \
facei = \
( \
star.starFaceFaces().size() > 0 \
? (star).starFaceFaces()[starFacei] \
: -1 \
); \
starFacei < star.starFaceFaces().size(); \
++ starFacei, \
facei = \
( \
starFacei < (star).starFaceFaces().size() \
? (star).starFaceFaces()[starFacei] \
: -1 \
) \
)
#define forAllStarEdges(star, i, starEdgei, edgei) \
for \
( \
label i = 0, \
starEdgei = 0, \
edgei = \
( \
(star).starEdgeEdges().size() > 0 \
? (star).starEdgeEdges()[0].edgei_ \
: -1 \
); \
i < (star).starEdgeEdges().size(); \
++ i, \
starEdgei = (star).starEdgeEdges()[starEdgei].starEdgei1_, \
edgei = \
( \
starEdgei != -1 \
? (star).starEdgeEdges()[starEdgei].edgei_ \
: -1 \
) \
)
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "starTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|