File size: 7,108 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::functionObjects::streamlines
Description
Generates streamline data by sampling a set of user-specified fields along
a particle track, transported by a user-specified velocity field.
Example of function object specification:
\verbatim
streamlines1
{
type streamlines;
libs ("libfieldFunctionObjects.so");
writeControl writeTime;
setFormat vtk;
U U;
direction both;
fields
(
U
p
);
lifeTime 10000;
trackLength 1e-3;
nSubCycle 5;
seedSampleSet
{
type lineUniform;
axis xyz;
start (-0.0205 0.0001 0.00001);
end (-0.0205 0.0005 0.00001);
nPoints 100;
}
}
\endverbatim
Usage
\table
Property | Description | Required | Default value
type | Type name: streamlines | yes |
setFormat | Output data type | yes |
U | Tracking velocity field name | no | U
direction | Direction in which to track | yes |
outside | Track outside of periodic meshes | no | no
fields | Fields to sample | yes |
writeTime | Write the flow time along the streamlines | no | no
lifetime | Maximum number of particle tracking steps | yes |
trackLength | Tracking segment length | no |
nSubCycle | Number of tracking steps per cell | no |
cloudName | Cloud name to use | no |
seedSampleSet | Seeding method (see below) | yes |
\endtable
Where the \c seedSampleSet \c type is typically one of
\plaintable
lineUniform | uniform particle seeding along a line
sphereRandom | random particle seeding within a sphere
boundaryRandom | random particle seeding on a number of patches
points | a specified set of locations
\endplaintable
Note:
When specifying the track resolution, the \c trackLength OR \c nSubCycle
option should be used
See also
Foam::functionObject
Foam::functionObjects::timeControl
Foam::sampledSet
SourceFiles
streamlines.C
\*---------------------------------------------------------------------------*/
#ifndef streamlines_functionObject_H
#define streamlines_functionObject_H
#include "fvMeshFunctionObject.H"
#include "setWriter.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class sampledSet;
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class streamlines Declaration
\*---------------------------------------------------------------------------*/
class streamlines
:
public fvMeshFunctionObject
{
public:
// Public data types
//- Track direction enumerations
enum class trackDirection
{
forward,
backward,
both
};
//- Track direction enumeration names
static const NamedEnum<trackDirection, 3> trackDirectionNames_;
private:
// Private Data
//- List of fields to sample
wordList fields_;
//- Field to transport particle with
word UName_;
//- Interpolation scheme to use
word interpolationScheme_;
//- The direction in which to track
trackDirection trackDirection_;
//- Whether or not to track outside of the mesh in periodic geometries
Switch trackOutside_;
//- Maximum lifetime (= number of cells) of particle
label lifeTime_;
//- Number of subcycling steps
label nSubCycle_;
//- Track length
scalar trackLength_;
//- Optional specified name of particles
word cloudName_;
//- Write the streamlines ages
Switch writeAge_;
//- Seed set engine
autoPtr<sampledSet> sampledSetPtr_;
//- File writer
autoPtr<setWriter> formatterPtr_;
public:
//- Runtime type information
TypeName("streamlines");
// Constructors
//- Construct from Time and dictionary
streamlines
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Disallow default bitwise copy construction
streamlines(const streamlines&) = delete;
//- Destructor
virtual ~streamlines();
// Member Functions
//- Read the field average data
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const;
//- Do nothing
virtual bool execute();
//- Calculate and write the streamlines
virtual bool write();
//- Update for mesh point-motion
virtual void movePoints(const polyMesh&);
//- Update topology using the given map
virtual void topoChange(const polyTopoChangeMap&);
//- Update from another mesh using the given map
virtual void mapMesh(const polyMeshMap&);
//- Redistribute or update using the given distribution map
virtual void distribute(const polyDistributionMap&);
// Member Operators
//- Disallow default bitwise assignment
void operator=(const streamlines&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|