File size: 9,553 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 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2025 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::streamlinesParticle
Description
Particle class that samples fields as it passes through. Used in streamlines
calculation.
SourceFiles
streamlinesParticle.C
\*---------------------------------------------------------------------------*/
#ifndef streamlinesParticle_H
#define streamlinesParticle_H
#include "particle.H"
#include "Cloud.H"
#include "autoPtr.H"
#include "interpolation.H"
#include "vectorList.H"
#include "DynamicField.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
class streamlinesParticle;
class streamlinesCloud;
Ostream& operator<<(Ostream&, const streamlinesParticle&);
/*---------------------------------------------------------------------------*\
Class streamlinesParticle Declaration
\*---------------------------------------------------------------------------*/
class streamlinesParticle
:
public particle
{
public:
class trackingData
:
public particle::trackingData
{
public:
// Public data
#define DeclareTypeInterpolator(Type, nullArg) \
const PtrList<interpolation<Type>>& Type##Interp_;
FOR_ALL_FIELD_TYPES(DeclareTypeInterpolator);
#undef DeclareTypeInterpolator
const interpolation<vector>& UInterp_;
bool trackForward_;
bool trackOutside_;
const label nSubCycle_;
const scalar trackLength_;
label tracki;
DynamicField<point>& allPositions_;
DynamicField<label>& allTracks_;
DynamicField<label>& allTrackParts_;
DynamicField<scalar>& allAges_;
#define DeclareAllTypes(Type, nullArg) \
List<DynamicField<Type>>& all##Type##s_;
FOR_ALL_FIELD_TYPES(DeclareAllTypes);
#undef DeclareAllTypes
// Constructors
//- Construct from components
trackingData
(
streamlinesCloud& cloud,
#define TypeInterpolatorArg(Type, nullArg) \
const PtrList<interpolation<Type>>& Type##Interp,
FOR_ALL_FIELD_TYPES(TypeInterpolatorArg)
#undef TypeInterpolatorArg
const interpolation<vector>& UInterp,
const bool trackForward,
const bool trackOutside,
const label nSubCycle,
const scalar trackLength,
DynamicField<point>& allPositions,
DynamicField<label>& allTracks,
DynamicField<label>& allTrackParts,
DynamicField<scalar>& allAges
#define AllTypesArg(Type, nullArg) \
, List<DynamicField<Type>>& all##Type##s
FOR_ALL_FIELD_TYPES(AllTypesArg)
#undef AllTypesArg
)
:
particle::trackingData(cloud),
#define TypeInterpolatorInit(Type, nullArg) \
Type##Interp_(Type##Interp),
FOR_ALL_FIELD_TYPES(TypeInterpolatorInit)
#undef TypeInterpolatorInit
UInterp_(UInterp),
trackForward_(trackForward),
trackOutside_(trackOutside),
nSubCycle_(nSubCycle),
trackLength_(trackLength),
allPositions_(allPositions),
allTracks_(allTracks),
allTrackParts_(allTrackParts),
allAges_(allAges)
#define AllTypesInit(Type, nullArg) \
, all##Type##s_(all##Type##s)
FOR_ALL_FIELD_TYPES(AllTypesInit)
#undef AllTypesInit
{}
};
private:
// Private Data
//- Lifetime of particle. Particle dies when reaches 0.
label lifeTime_;
//- Index of the track
label trackIndex_;
//- Index of the part of the track
label trackPartIndex_;
//- Age of the particle
scalar age_;
//- Current compound transform
transformer transform_;
//- Sampled positions
DynamicField<point> sampledPositions_;
//- Sampled ages
DynamicField<scalar> sampledAges_;
//- Sampled types
#define DeclareSampledTypes(Type, nullArg) \
List<DynamicField<Type>> sampled##Type##s_;
FOR_ALL_FIELD_TYPES(DeclareSampledTypes);
#undef DeclareSampledTypes
// Private Member Functions
//- Interpolate all quantities; return interpolated velocity.
vector interpolateFields
(
const trackingData&,
const point&,
const label celli,
const label facei
);
//- End the current track
void endTrack(trackingData&);
public:
// Static Data Members
//- Streamlines are computed at an instant
static const bool instantaneous = true;
// Constructors
//- Construct from a position and a cell, searching for the rest of the
// required topology
streamlinesParticle
(
const meshSearch& searchEngine,
const vector& position,
const label celli,
label& nLocateBoundaryHits,
const label lifeTime,
const label trackIndex
);
//- Construct from Istream
streamlinesParticle(Istream& is, bool readFields = true);
//- Construct copy
streamlinesParticle(const streamlinesParticle& p);
//- Construct and return a clone
autoPtr<particle> clone() const
{
return autoPtr<particle>(new streamlinesParticle(*this));
}
//- Construct from Istream and return
static autoPtr<streamlinesParticle> New(Istream& is)
{
return autoPtr<streamlinesParticle>(new streamlinesParticle(is));
}
// Member Functions
// Tracking
//- Track all particles to their end point
bool move(streamlinesCloud&, trackingData&);
//- Overridable function to handle the particle hitting a wedge
void hitWedgePatch(streamlinesCloud&, trackingData&);
//- Overridable function to handle the particle hitting a
// symmetry plane
void hitSymmetryPlanePatch(streamlinesCloud&, trackingData&);
//- Overridable function to handle the particle hitting a
// symmetry patch
void hitSymmetryPatch(streamlinesCloud&, trackingData&);
//- Overridable function to handle the particle hitting a cyclic
void hitCyclicPatch(streamlinesCloud&, trackingData&);
//- Overridable function to handle the particle hitting an
// nonConformalCyclicPolyPatch
bool hitNonConformalCyclicPatch
(
const vector& displacement,
const scalar fraction,
const label patchi,
streamlinesCloud& cloud,
trackingData& td
);
//- Overridable function to handle the particle hitting a
// processorPatch
void hitProcessorPatch(streamlinesCloud&, trackingData&);
//- Overridable function to handle the particle hitting a wallPatch
void hitWallPatch(streamlinesCloud&, trackingData&);
// Transformations
//- Transform the physical properties of the particle
// according to the given transformation tensor
virtual void transformProperties(const transformer&);
// I-O
//- Read
static void readFields
(
lagrangian::Cloud<streamlinesParticle>&
);
//- Write
static void writeFields
(
const lagrangian::Cloud<streamlinesParticle>&
);
// Ostream Operator
friend Ostream& operator<<(Ostream&, const streamlinesParticle&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|