ENH: streamline improvements

- barycentric coordinates in interpolation (instead of x/y/z)

- ease U (velocity) requirement.
  Needn't be named in the sampled fields.

- default tracking direction is 'forward'

etc/caseDicts/postProcessing/visualization/streamlines.cfg

@@ -13,7 +13,7 @@ executeControl  writeTime;
 writeControl    writeTime;
 
 setFormat       vtk;
-trackForward    true;
+direction       forward;   // (forward | backward | bidirectional)
 
 lifeTime        10000;
 nSubCycle       5;

src/functionObjects/field/streamLine/streamLine.C

@@ -6,7 +6,7 @@
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
     Copyright (C) 2011-2016 OpenFOAM Foundation
-    Copyright (C) 2015-2020 OpenCFD Ltd.
+    Copyright (C) 2015-2022 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -92,22 +92,14 @@ void Foam::functionObjects::streamLine::track()
 
     Log << "    seeded " << nSeeds << " particles" << endl;
 
-    // Read or lookup fields
+    // Field interpolators
-    PtrList<volScalarField> vsFlds;
+    // Velocity interpolator
     PtrList<interpolation<scalar>> vsInterp;
-    PtrList<volVectorField> vvFlds;
     PtrList<interpolation<vector>> vvInterp;
 
-    label UIndex = -1;
+    refPtr<interpolation<vector>> UInterp
-
-    initInterpolations
     (
-        nSeeds,
+        initInterpolations(nSeeds, vsInterp, vvInterp)
-        UIndex,
-        vsFlds,
-        vsInterp,
-        vvFlds,
-        vvInterp
     );
 
     // Additional particle info
@@ -116,7 +108,7 @@ void Foam::functionObjects::streamLine::track()
         particles,
         vsInterp,
         vvInterp,
-        UIndex,         // index of U in vvInterp
+        UInterp.cref(), // velocity interpolator (possibly within vvInterp)
         nSubCycle_,     // automatic track control:step through cells in steps?
         trackLength_,   // fixed track length
 
@@ -174,7 +166,6 @@ bool Foam::functionObjects::streamLine::read(const dictionary& dict)
             trackLength_ = VGREAT;
             nSubCycle_ = max(nSubCycle_, 1);
 
-
             Info<< "    automatic track length specified through"
                 << " number of sub cycles : " << nSubCycle_ << nl
                 << endl;

src/functionObjects/field/streamLine/streamLine.H

@@ -6,7 +6,7 @@
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
     Copyright (C) 2011-2017 OpenFOAM Foundation
-    Copyright (C) 2015-2020 OpenCFD Ltd.
+    Copyright (C) 2015-2022 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -52,13 +52,15 @@ Usage
         type            streamLine;
         libs            (fieldFunctionObjects);
 
-        // Mandatory entries (runtime modifiable)
+        // Optional entries
-        U               <fieldTrack>;
+        U               <velocity-name>;
-        fields          (<fieldTrack> <field1> ... <fieldN>);
+        direction       forward;
-        setFormat       vtk;
-        direction       bidirectional;
-        lifeTime        10000;
         cloud           particleTracks;
+
+        // Mandatory entries (runtime modifiable)
+        fields          (<field1> ... <fieldN>);
+        setFormat       vtk;
+        lifeTime        10000;
         seedSampleSet
         {
             type        uniform;
@@ -87,20 +89,20 @@ Usage
       Property     | Description                           | Type | Req'd | Dflt
       type         | Type name: streamLine                 | word |  yes  | -
       libs         | Library name: fieldFunctionObjects    | word |  yes  | -
-      U            | Name of tracking velocity field       | word |  yes  | -
+      U            | Name of tracking velocity field       | word |  no   | U
       fields       | Names of operand fields to sample     | wordList | yes | -
       setFormat    | Type of output data                   | word |  yes  | -
-      direction    | Direction to track                    | vector | yes | -
+      direction    | Direction (enum) to track             | word |  no   | forward
       lifetime     | Maximum number of particle tracking steps | label | yes | -
-      cloud        | Name of cloud                         | word |  yes  | -
+      cloud        | Cloud name to use for streamlines     | word |  no  | typeName
-      seedSampleSet| Name of seeding method (see below)    | word |  yes  | -
+      seedSampleSet| Seeding description (see below)       | dict |  yes  | -
-      bounds       | Bounding box to trim tracks    | vector | no | invertedBox
+      bounds       | Bounding box to trim tracks    | vector pair | no | -
       trackLength  | Tracking segment length              | scalar | no | VGREAT
       nSubCycle    | Number of tracking steps per cell    | label  | no | 1
       interpolationScheme | Interp. scheme for sample   | word | no | cellPoint
     \endtable
 
-    Options for the \c seedSampleSet entry:
+    Example types for the \c seedSampleSet sub-dict:
     \verbatim
         uniform | uniform particle seeding
         cloud   | cloud of points
@@ -120,9 +122,9 @@ Usage
 
     Options for the \c direction entry:
     \verbatim
-        bidirectional
         forward
         backward
+        bidirectional
     \endverbatim
 
     The inherited entries are elaborated in:
@@ -147,8 +149,8 @@ SourceFiles
 
 \*---------------------------------------------------------------------------*/
 
-#ifndef functionObjects_streamLine_H
+#ifndef Foam_functionObjects_streamLine_H
-#define functionObjects_streamLine_H
+#define Foam_functionObjects_streamLine_H
 
 #include "streamLineBase.H"
 
@@ -157,6 +159,7 @@ SourceFiles
 namespace Foam
 {
 
+// Forward Declarations
 class objectRegistry;
 class dictionary;
 
@@ -169,7 +172,7 @@ namespace functionObjects
 
 class streamLine
 :
-    public streamLineBase
+    public functionObjects::streamLineBase
 {
     // Private Data
 

src/functionObjects/field/streamLine/streamLineBase.C

@@ -139,17 +139,16 @@ Foam::functionObjects::streamLineBase::wallPatch() const
 }
 
 
-void Foam::functionObjects::streamLineBase::initInterpolations
+Foam::refPtr<Foam::interpolation<Foam::vector>>
+Foam::functionObjects::streamLineBase::initInterpolations
 (
     const label nSeeds,
-    label& UIndex,
-    PtrList<volScalarField>& vsFlds,
     PtrList<interpolation<scalar>>& vsInterp,
-    PtrList<volVectorField>& vvFlds,
     PtrList<interpolation<vector>>& vvInterp
 )
 {
-    // Read fields
+    refPtr<interpolation<vector>> UInterp;
+
     label nScalar = 0;
     label nVector = 0;
 
@@ -166,7 +165,7 @@ void Foam::functionObjects::streamLineBase::initInterpolations
         else
         {
             FatalErrorInFunction
-                << "Cannot find field " << fieldName << nl
+                << "Cannot find scalar/vector field " << fieldName << nl
                 << "Valid scalar fields: "
                 << flatOutput(mesh_.sortedNames<volScalarField>()) << nl
                 << "Valid vector fields: "
@@ -174,9 +173,9 @@ void Foam::functionObjects::streamLineBase::initInterpolations
                 << exit(FatalError);
         }
     }
-    vsInterp.setSize(nScalar);
+    vsInterp.resize(nScalar);
+    vvInterp.resize(nVector);
     nScalar = 0;
-    vvInterp.setSize(nVector);
     nVector = 0;
 
     for (const word& fieldName : fields_)
@@ -186,76 +185,77 @@ void Foam::functionObjects::streamLineBase::initInterpolations
             const volScalarField& f = lookupObject<volScalarField>(fieldName);
             vsInterp.set
             (
-                nScalar++,
+                nScalar,
-                interpolation<scalar>::New
+                interpolation<scalar>::New(interpolationScheme_, f)
-                (
-                    interpolationScheme_,
-                    f
-                )
             );
+            ++nScalar;
         }
         else if (foundObject<volVectorField>(fieldName))
         {
             const volVectorField& f = lookupObject<volVectorField>(fieldName);
 
-            if (f.name() == UName_)
-            {
-                UIndex = nVector;
-            }
-
             vvInterp.set
             (
-                nVector++,
+                nVector,
-                interpolation<vector>::New
+                interpolation<vector>::New(interpolationScheme_, f)
-                (
-                    interpolationScheme_,
-                    f
-                )
             );
+
+            if (f.name() == UName_)
+            {
+                // Velocity is part of sampled velocity fields
+                UInterp.cref(vvInterp[nVector]);
+            }
+
+            ++nVector;
         }
     }
 
+    if (!UInterp)
+    {
+        // Velocity was not in sampled velocity fields
+        UInterp.reset
+        (
+            interpolation<vector>::New
+            (
+                interpolationScheme_,
+                // Fatal if missing
+                lookupObject<volVectorField>(UName_)
+            )
+        );
+    }
+
     // Store the names
-    scalarNames_.setSize(vsInterp.size());
+    scalarNames_.resize(vsInterp.size());
     forAll(vsInterp, i)
     {
         scalarNames_[i] = vsInterp[i].psi().name();
     }
-    vectorNames_.setSize(vvInterp.size());
+    vectorNames_.resize(vvInterp.size());
     forAll(vvInterp, i)
     {
         vectorNames_[i] = vvInterp[i].psi().name();
     }
 
-    // Check that we know the index of U in the interpolators.
-
-    if (UIndex == -1)
-    {
-        FatalErrorInFunction
-            << "Cannot find field to move particles with : " << UName_ << nl
-            << "This field has to be present in the sampled fields " << fields_
-            << " and in the objectRegistry."
-            << exit(FatalError);
-    }
-
     // Sampled data
     // ~~~~~~~~~~~~
 
     // Size to maximum expected sizes.
     allTracks_.clear();
     allTracks_.setCapacity(nSeeds);
-    allScalars_.setSize(vsInterp.size());
+    allScalars_.resize(vsInterp.size());
     forAll(allScalars_, i)
     {
         allScalars_[i].clear();
         allScalars_[i].setCapacity(nSeeds);
     }
-    allVectors_.setSize(vvInterp.size());
+    allVectors_.resize(vvInterp.size());
     forAll(allVectors_, i)
     {
         allVectors_[i].clear();
         allVectors_[i].setCapacity(nSeeds);
     }
+
+    return UInterp;
 }
 
 
@@ -877,22 +877,13 @@ bool Foam::functionObjects::streamLineBase::read(const dictionary& dict)
     Info<< type() << " " << name() << ":" << nl;
 
     UName_ = dict.getOrDefault<word>("U", "U");
+    Info<< "    Employing velocity field " << UName_ << endl;
 
     if (fields_.empty())
     {
         dict.readEntry("fields", fields_);
-
-        if (!fields_.found(UName_))
-        {
-            FatalIOErrorInFunction(dict)
-                << "Velocity field for tracking " << UName_
-                << " should be present in the list of fields " << fields_
-                << exit(FatalIOError);
-        }
     }
 
-    Info<< "    Employing velocity field " << UName_ << endl;
-
     bool trackForward;
     if (dict.readIfPresent("trackForward", trackForward))
     {
@@ -912,7 +903,12 @@ bool Foam::functionObjects::streamLineBase::read(const dictionary& dict)
     }
     else
     {
-        trackDir_ = trackDirTypeNames.get("direction", dict);
+        trackDir_ = trackDirTypeNames.getOrDefault
+        (
+            "direction",
+            dict,
+            trackDirType::FORWARD
+        );
     }
     dict.readEntry("lifeTime", lifeTime_);
     if (lifeTime_ < 1)

src/functionObjects/field/streamLine/streamLineBase.H

@@ -75,9 +75,9 @@ public:
         //- Enumeration defining the track direction
         enum trackDirType : char
         {
-            FORWARD,
+            FORWARD,            //!< Use "forward" tracking
-            BACKWARD,
+            BACKWARD,           //!< Use "backward" tracking
-            BIDIRECTIONAL
+            BIDIRECTIONAL,      //!< Use "bidirectional" tracking
         };
 
         //- Names for the trackDir
@@ -104,7 +104,7 @@ protected:
         //- Interpolation scheme to use
         word interpolationScheme_;
 
-        //- Whether to use +u or -u or both
+        //- Whether to use +U, -U or both
         trackDirType trackDir_;
 
         //- Maximum lifetime (= number of cells) of particle
@@ -129,7 +129,7 @@ protected:
         wordList vectorNames_;
 
 
-    // Demand driven
+    // Demand Driven
 
         //- File writer for tracks data
         mutable autoPtr<coordSetWriter> trackWriterPtr_;
@@ -159,14 +159,13 @@ protected:
         //- Construct patch out of all wall patch faces
         autoPtr<indirectPrimitivePatch> wallPatch() const;
 
-        //- Initialise fields, interpolators and track storage
+        //- Initialise interpolators and track storage
-        void initInterpolations
+        //  Return velocity interpolator: standalone or part of vector
+        //  interpolators
+        refPtr<interpolation<vector>> initInterpolations
         (
             const label nSeeds,
-            label& UIndex,
-            PtrList<volScalarField>& vsFlds,
             PtrList<interpolation<scalar>>& vsInterp,
-            PtrList<volVectorField>& vvFlds,
             PtrList<interpolation<vector>>& vvInterp
         );
 

src/functionObjects/field/streamLine/streamLineParticle.C

@@ -6,7 +6,7 @@
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
     Copyright (C) 2011-2017 OpenFOAM Foundation
-    Copyright (C) 2019 OpenCFD Ltd.
+    Copyright (C) 2019-2022 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -35,48 +35,67 @@ License
 Foam::vector Foam::streamLineParticle::interpolateFields
 (
     const trackingData& td,
-    const point& position,
+    const barycentric& tetCoords,
-    const label celli,
+    const tetIndices& tetIs
-    const label facei
 )
 {
-    if (celli == -1)
+    if (tetIs.cell() < 0)
     {
         FatalErrorInFunction
-            << "Cell:" << celli << abort(FatalError);
+            << "Invalid cell (-1)" << abort(FatalError);
     }
 
-    sampledScalars_.setSize(td.vsInterp_.size());
+    const point position
-    forAll(td.vsInterp_, scalari)
+    (
+        tetIs.barycentricToPoint(this->mesh(), tetCoords)
+    );
+
+    bool foundU = false;
+    vector U(Zero);
+
+    // If current position is different
+    if
+    (
+        sampledPositions_.empty()
+     || magSqr(sampledPositions_.last() - position) > Foam::sqr(SMALL)
+    )
     {
-        sampledScalars_[scalari].append
+        // Store new location
-        (
+        sampledPositions_.append(position);
-            td.vsInterp_[scalari].interpolate
+
+        // Scalar fields
+        sampledScalars_.resize(td.vsInterp_.size());
+        forAll(td.vsInterp_, i)
+        {
+            sampledScalars_[i].append
             (
-                position,
+                td.vsInterp_[i].interpolate(tetCoords, tetIs, tetIs.face())
-                celli,
+            );
-                facei
+        }
-            )
+
-        );
+        // Vector fields
+        sampledVectors_.resize(td.vvInterp_.size());
+        forAll(td.vvInterp_, i)
+        {
+            sampledVectors_[i].append
+            (
+                td.vvInterp_[i].interpolate(tetCoords, tetIs, tetIs.face())
+            );
+
+            if (td.vvInterp_.get(i) == &(td.UInterp_))
+            {
+                foundU = true;
+                U = sampledVectors_[i].last();
+            }
+        }
     }
 
-    sampledVectors_.setSize(td.vvInterp_.size());
+    if (!foundU)
-    forAll(td.vvInterp_, vectori)
     {
-        sampledVectors_[vectori].append
+        U = td.UInterp_.interpolate(tetCoords, tetIs, tetIs.face());
-        (
-            td.vvInterp_[vectori].interpolate
-            (
-                position,
-                celli,
-                facei
-            )
-        );
     }
 
-    const DynamicList<vector>& U = sampledVectors_[td.UIndex_];
+    return U;
-
-    return U.last();
 }
 
 
@@ -116,12 +135,12 @@ Foam::streamLineParticle::streamLineParticle
             >> sampledPositions_ >> sampledScalars
             >> sampledVectors;
 
-        sampledScalars_.setSize(sampledScalars.size());
+        sampledScalars_.resize(sampledScalars.size());
         forAll(sampledScalars, i)
         {
             sampledScalars_[i].transfer(sampledScalars[i]);
         }
-        sampledVectors_.setSize(sampledVectors.size());
+        sampledVectors_.resize(sampledVectors.size());
         forAll(sampledVectors, i)
         {
             sampledVectors_[i].transfer(sampledVectors[i]);
@@ -162,6 +181,7 @@ bool Foam::streamLineParticle::move
 
     while (td.keepParticle && !td.switchProcessor && lifeTime_ > 0)
     {
+        // Set the lagrangian time-step
         scalar dt = maxDt;
 
         // Cross cell in steps:
@@ -171,16 +191,11 @@ bool Foam::streamLineParticle::move
         {
             --lifeTime_;
 
-            // Store current position and sampled velocity.
+            // Store current position, return sampled velocity
-            sampledPositions_.append(position());
+            vector U =
-            vector U = interpolateFields(td, position(), cell(), face());
+                interpolateFields(td, coordinates(), currentTetIndices());
 
-            if (!trackForward_)
+            const scalar magU = mag(U);
-            {
-                U = -U;
-            }
-
-            scalar magU = mag(U);
 
             if (magU < SMALL)
             {
@@ -189,6 +204,11 @@ bool Foam::streamLineParticle::move
                 break;
             }
 
+            if (!trackForward_)
+            {
+                U = -U;
+            }
+
             U /= magU;
 
             if (td.trackLength_ < GREAT)
@@ -240,8 +260,7 @@ bool Foam::streamLineParticle::move
         else
         {
             // Normal exit. Store last position and fields
-            sampledPositions_.append(position());
+            (void)interpolateFields(td, coordinates(), currentTetIndices());
-            interpolateFields(td, position(), cell(), face());
 
             if (debug)
             {
@@ -252,21 +271,20 @@ bool Foam::streamLineParticle::move
         }
 
         // Transfer particle data into trackingData.
-        td.allPositions_.append(vectorList());
+        {
-        vectorList& top = td.allPositions_.last();
+            td.allPositions_.append(vectorList());
-        top.transfer(sampledPositions_);
+            td.allPositions_.last().transfer(sampledPositions_);
+        }
 
         forAll(sampledScalars_, i)
         {
             td.allScalars_[i].append(scalarList());
-            scalarList& top = td.allScalars_[i].last();
+            td.allScalars_[i].last().transfer(sampledScalars_[i]);
-            top.transfer(sampledScalars_[i]);
         }
         forAll(sampledVectors_, i)
         {
             td.allVectors_[i].append(vectorList());
-            vectorList& top = td.allVectors_[i].last();
+            td.allVectors_[i].last().transfer(sampledVectors_[i]);
-            top.transfer(sampledVectors_[i]);
         }
     }
 
@@ -406,6 +424,7 @@ void Foam::streamLineParticle::writeFields(const Cloud<streamLineParticle>& c)
     particle::writeFields(c);
 
     const label np = c.size();
+    const bool valid = c.size();
 
     IOField<label> lifeTime
     (
@@ -426,8 +445,8 @@ void Foam::streamLineParticle::writeFields(const Cloud<streamLineParticle>& c)
         ++i;
     }
 
-    lifeTime.write(np > 0);
+    lifeTime.write(valid);
-    sampledPositions.write(np > 0);
+    sampledPositions.write(valid);
 }
 
 

src/functionObjects/field/streamLine/streamLineParticle.H

@@ -6,6 +6,7 @@
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
     Copyright (C) 2011-2017 OpenFOAM Foundation
+    Copyright (C) 2022 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -27,8 +28,8 @@ Class
     Foam::streamLineParticle
 
 Description
-    Particle class that samples fields as it passes through. Used in streamline
+    Particle class that samples fields as it passes through.
-    calculation.
+    Used in streamline calculation.
 
 SourceFiles
     streamLineParticle.C
@@ -70,23 +71,17 @@ public:
     {
     public:
 
-        // Public data
+        // Public Data
 
-            const PtrList<interpolation<scalar>>& vsInterp_;
+        const PtrList<interpolation<scalar>>& vsInterp_;
+        const PtrList<interpolation<vector>>& vvInterp_;
+        const interpolation<vector>& UInterp_;
+        const label nSubCycle_;
+        const scalar trackLength_;
 
-            const PtrList<interpolation<vector>>& vvInterp_;
+        DynamicList<vectorList>& allPositions_;
-
+        List<DynamicList<scalarList>>& allScalars_;
-            const label UIndex_;
+        List<DynamicList<vectorList>>& allVectors_;
-
-            const label nSubCycle_;
-
-            const scalar trackLength_;
-
-            DynamicList<vectorList>& allPositions_;
-
-            List<DynamicList<scalarList>>& allScalars_;
-
-            List<DynamicList<vectorList>>& allVectors_;
 
 
         // Constructors
@@ -97,7 +92,7 @@ public:
                 streamLineParticleCloud& cloud,
                 const PtrList<interpolation<scalar>>& vsInterp,
                 const PtrList<interpolation<vector>>& vvInterp,
-                const label UIndex,
+                const interpolation<vector>& UInterp,
                 const label nSubCycle,
                 const scalar trackLength,
                 DynamicList<List<point>>& allPositions,
@@ -108,7 +103,7 @@ public:
                 particle::trackingData(cloud),
                 vsInterp_(vsInterp),
                 vvInterp_(vvInterp),
-                UIndex_(UIndex),
+                UInterp_(UInterp),
                 nSubCycle_(nSubCycle),
                 trackLength_(trackLength),
                 allPositions_(allPositions),
@@ -120,7 +115,7 @@ public:
 
 private:
 
-    // Private data
+    // Private Data
 
         //- Whether particle transports with +U or -U
         bool trackForward_;
@@ -140,13 +135,12 @@ private:
 
     // Private Member Functions
 
-        //- Interpolate all quantities; return interpolated velocity.
+        //- Interpolate quantities; return interpolated velocity.
         vector interpolateFields
         (
-            const trackingData&,
+            const trackingData& td,
-            const point&,
+            const barycentric& tetCoords,
-            const label celli,
+            const tetIndices& tetIs
-            const label facei
         );
 
 
@@ -157,7 +151,7 @@ public:
         //- Construct from components
         streamLineParticle
         (
-            const polyMesh& c,
+            const polyMesh& mesh,
             const vector& position,
             const label celli,
             const bool trackForward,
@@ -167,7 +161,7 @@ public:
         //- Construct from Istream
         streamLineParticle
         (
-            const polyMesh& c,
+            const polyMesh& mesh,
             Istream& is,
             bool readFields = true,
             bool newFormat = true

src/functionObjects/field/streamLine/streamLineParticleCloud.C

@@ -34,6 +34,7 @@ namespace Foam
     defineTemplateTypeNameAndDebug(Cloud<streamLineParticle>, 0);
 }
 
+
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
 Foam::streamLineParticleCloud::streamLineParticleCloud

src/functionObjects/field/streamLine/streamLineParticleCloud.H

@@ -6,7 +6,7 @@
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
     Copyright (C) 2011-2016 OpenFOAM Foundation
-    Copyright (C) 2019 OpenCFD Ltd.
+    Copyright (C) 2019-2022 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -31,12 +31,12 @@ Description
     A Cloud of streamLine particles
 
 SourceFiles
-    streamLineCloud.C
+    streamLineParticleCloud.C
 
 \*---------------------------------------------------------------------------*/
 
-#ifndef streamLineParticleCloud_H
+#ifndef Foam_streamLineParticleCloud_H
-#define streamLineParticleCloud_H
+#define Foam_streamLineParticleCloud_H
 
 #include "Cloud.H"
 #include "streamLineParticle.H"
@@ -47,14 +47,20 @@ namespace Foam
 {
 
 /*---------------------------------------------------------------------------*\
-                      Class streamLineCloud Declaration
+                   Class streamLineParticleCloud Declaration
 \*---------------------------------------------------------------------------*/
 
 class streamLineParticleCloud
 :
     public Cloud<streamLineParticle>
 {
-    // Private Member Functions
+public:
+
+    //- Type of parcel the cloud was instantiated for
+    typedef streamLineParticle parcelType;
+
+
+    // Generated Methods
 
         //- No copy construct
         streamLineParticleCloud(const streamLineParticleCloud&) = delete;
@@ -63,12 +69,6 @@ class streamLineParticleCloud
         void operator=(const streamLineParticleCloud&) = delete;
 
 
-public:
-
-    //- Type of parcel the cloud was instantiated for
-    typedef streamLineParticle parcelType;
-
-
     // Constructors
 
         //- Construct given mesh

src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.C

@@ -6,7 +6,7 @@
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
     Copyright (C) 2011-2016 OpenFOAM Foundation
-    Copyright (C) 2015-2020 OpenCFD Ltd.
+    Copyright (C) 2015-2022 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -231,23 +231,13 @@ void Foam::functionObjects::wallBoundedStreamLine::track()
     Log << type() << " : seeded " << nSeeds << " particles." << endl;
 
 
-
+    // Field interpolators
-    // Read or lookup fields
-    PtrList<volScalarField> vsFlds;
     PtrList<interpolation<scalar>> vsInterp;
-    PtrList<volVectorField> vvFlds;
     PtrList<interpolation<vector>> vvInterp;
 
-    label UIndex = -1;
+    refPtr<interpolation<vector>> UInterp
-
-    initInterpolations
     (
-        nSeeds,
+        initInterpolations(nSeeds, vsInterp, vvInterp)
-        UIndex,
-        vsFlds,
-        vsInterp,
-        vvFlds,
-        vvInterp
     );
 
     // Additional particle info
@@ -256,7 +246,7 @@ void Foam::functionObjects::wallBoundedStreamLine::track()
         particles,
         vsInterp,
         vvInterp,
-        UIndex,         // index of U in vvInterp
+        UInterp.cref(), // velocity interpolator (possibly within vvInterp)
         trackLength_,   // fixed track length
         isWallPatch,    // which faces are to follow
 

src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H

@@ -52,13 +52,15 @@ Usage
         type            wallBoundedStreamLine;
         libs            (fieldFunctionObjects);
 
-        // Mandatory entries (runtime modifiable)
+        // Optional entries
-        U               <fieldTrack>;
+        U               <velocity-name>;
-        fields          (<fieldTrack> <field1> ... <fieldN>);
+        direction       forward;
-        setFormat       vtk;
-        direction       bidirectional;
-        lifeTime        10000;
         cloud           particleTracks;
+
+        // Mandatory entries (runtime modifiable)
+        fields          (<field1> ... <fieldN>);
+        setFormat       vtk;
+        lifeTime        10000;
         seedSampleSet
         {
             type        patchSeed;
@@ -89,17 +91,17 @@ Usage
       U            | Name of tracking velocity field       | word |  yes  | -
       fields       | Names of operand fields to sample     | wordList | yes | -
       setFormat    | Type of output data                   | word |  yes  | -
-      direction    | Direction to track                    | vector | yes | -
+      direction    | Direction (enum) to track             | word |  no   | forward
       lifetime     | Maximum number of particle tracking steps | label | yes | -
-      cloud        | Name of cloud                         | word |  yes  | -
+      cloud        | Cloud name to use for streamlines     | word |  no  | typeName
-      seedSampleSet| Name of seeding method (see below)    | word |  yes  | -
+      seedSampleSet| Seeding description (see below)       | dict |  yes  | -
-      bounds       | Bounding box to trim tracks    | vector | no | invertedBox
+      bounds       | Bounding box to trim tracks    | vector pair | no | -
       trackLength  | Tracking segment length              | scalar | no | VGREAT
       nSubCycle    | Number of tracking steps per cell    | label  | no | 1
       interpolationScheme | Interp. scheme for sample   | word | no | cellPoint
     \endtable
 
-    Options for the \c seedSampleSet entry:
+    Example types for the \c seedSampleSet sub-dict:
     \verbatim
       uniform   | uniform particle seeding
       cloud     | cloud of points
@@ -120,9 +122,9 @@ Usage
 
     Options for the \c direction entry:
     \verbatim
-        bidirectional
         forward
         backward
+        bidirectional
     \endverbatim
 
     The inherited entries are elaborated in:
@@ -144,8 +146,8 @@ SourceFiles
 
 \*---------------------------------------------------------------------------*/
 
-#ifndef functionObjects_wallBoundedStreamLine_H
+#ifndef Foam_functionObjects_wallBoundedStreamLine_H
-#define functionObjects_wallBoundedStreamLine_H
+#define Foam_functionObjects_wallBoundedStreamLine_H
 
 #include "streamLineBase.H"
 
@@ -153,7 +155,6 @@ SourceFiles
 
 namespace Foam
 {
-
 namespace functionObjects
 {
 
@@ -163,7 +164,7 @@ namespace functionObjects
 
 class wallBoundedStreamLine
 :
-    public streamLineBase
+    public functionObjects::streamLineBase
 {
 protected:
 

src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLineParticle.C

@@ -6,7 +6,7 @@
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
     Copyright (C) 2011-2016 OpenFOAM Foundation
-    Copyright (C) 2017-2019 OpenCFD Ltd.
+    Copyright (C) 2017-2022 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -39,53 +39,57 @@ Foam::vector Foam::wallBoundedStreamLineParticle::interpolateFields
     const label facei
 )
 {
-    if (celli == -1)
+    if (celli < 0)
     {
         FatalErrorInFunction
-            << "Cell:" << celli << abort(FatalError);
+            << "Invalid cell (-1)" << abort(FatalError);
     }
 
-    const vector U =
+    bool foundU = false;
-        td.vvInterp_[td.UIndex_].interpolate(position, celli, facei);
+    vector U(Zero);
 
-    // Check if at different position
+    // If current position is different
     if
     (
-       !sampledPositions_.size()
+        sampledPositions_.empty()
      || magSqr(sampledPositions_.last() - position) > Foam::sqr(SMALL)
     )
     {
-        // Store the location
+        // Store new location
         sampledPositions_.append(position);
 
-        // Store the scalar fields
+        // Scalar fields
-        sampledScalars_.setSize(td.vsInterp_.size());
+        sampledScalars_.resize(td.vsInterp_.size());
-        forAll(td.vsInterp_, scalari)
+        forAll(td.vsInterp_, i)
         {
-            sampledScalars_[scalari].append
+            sampledScalars_[i].append
             (
-                td.vsInterp_[scalari].interpolate(position, celli, facei)
+                td.vsInterp_[i].interpolate(position, celli, facei)
             );
         }
 
-        // Store the vector fields
+        // Vector fields
-        sampledVectors_.setSize(td.vvInterp_.size());
+        sampledVectors_.resize(td.vvInterp_.size());
-        forAll(td.vvInterp_, vectori)
+        forAll(td.vvInterp_, i)
         {
-            vector positionU;
+            sampledVectors_[i].append
-            if (vectori == td.UIndex_)
+            (
+                td.vvInterp_[i].interpolate(position, celli, facei)
+            );
+
+            if (td.vvInterp_.get(i) == &(td.UInterp_))
             {
-                positionU = U;
+                foundU = true;
+                U = sampledVectors_[i].last();
             }
-            else
-            {
-                positionU =
-                    td.vvInterp_[vectori].interpolate(position, celli, facei);
-            }
-            sampledVectors_[vectori].append(positionU);
         }
     }
 
+    if (!foundU)
+    {
+        U = td.UInterp_.interpolate(position, celli, facei);
+    }
+
     return U;
 }
 
@@ -97,12 +101,7 @@ Foam::vector Foam::wallBoundedStreamLineParticle::sample
 {
     vector U = interpolateFields(td, localPosition_, cell(), face());
 
-    if (!trackForward_)
+    const scalar magU = mag(U);
-    {
-        U = -U;
-    }
-
-    scalar magU = mag(U);
 
     if (magU < SMALL)
     {
@@ -110,10 +109,13 @@ Foam::vector Foam::wallBoundedStreamLineParticle::sample
         lifeTime_ = 0;
         return vector::zero;
     }
-    else
+
+    if (!trackForward_)
     {
-        return U/magU;
+        U = -U;
     }
+
+    return U/magU;
 }
 
 
@@ -165,12 +167,12 @@ Foam::wallBoundedStreamLineParticle::wallBoundedStreamLineParticle
         is  >> trackForward_ >> lifeTime_
             >> sampledPositions_ >> sampledScalars >> sampledVectors;
 
-        sampledScalars_.setSize(sampledScalars.size());
+        sampledScalars_.resize(sampledScalars.size());
         forAll(sampledScalars, i)
         {
             sampledScalars_[i].transfer(sampledScalars[i]);
         }
-        sampledVectors_.setSize(sampledVectors.size());
+        sampledVectors_.resize(sampledVectors.size());
         forAll(sampledVectors, i)
         {
             sampledVectors_[i].transfer(sampledVectors[i]);

src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLineParticle.H

@@ -6,7 +6,7 @@
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
     Copyright (C) 2011-2016 OpenFOAM Foundation
-    Copyright (C) 2017-2019 OpenCFD Ltd.
+    Copyright (C) 2017-2022 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -74,9 +74,11 @@ public:
     {
     public:
 
+        // Public Data
+
         const PtrList<interpolation<scalar>>& vsInterp_;
         const PtrList<interpolation<vector>>& vvInterp_;
-        const label UIndex_;
+        const interpolation<vector>& UInterp_;
         const scalar trackLength_;
 
         DynamicList<vectorList>& allPositions_;
@@ -92,7 +94,7 @@ public:
                 TrackCloudType& cloud,
                 const PtrList<interpolation<scalar>>& vsInterp,
                 const PtrList<interpolation<vector>>& vvInterp,
-                const label UIndex,
+                const interpolation<vector>& UInterp,
                 const scalar trackLength,
                 const bitSet& isWallPatch,
 
@@ -104,7 +106,7 @@ public:
                 wallBoundedParticle::trackingData(cloud, isWallPatch),
                 vsInterp_(vsInterp),
                 vvInterp_(vvInterp),
-                UIndex_(UIndex),
+                UInterp_(UInterp),
                 trackLength_(trackLength),
 
                 allPositions_(allPositions),

src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLineParticleCloud.H

@@ -35,8 +35,8 @@ SourceFiles
 
 \*---------------------------------------------------------------------------*/
 
-#ifndef wallBoundedStreamLineParticleCloud_H
+#ifndef Foam_wallBoundedStreamLineParticleCloud_H
-#define wallBoundedStreamLineParticleCloud_H
+#define Foam_wallBoundedStreamLineParticleCloud_H
 
 #include "Cloud.H"
 #include "wallBoundedStreamLineParticle.H"
@@ -54,7 +54,13 @@ class wallBoundedStreamLineParticleCloud
 :
     public Cloud<wallBoundedStreamLineParticle>
 {
-    // Private Member Functions
+public:
+
+    //- Type of parcel the cloud was instantiated for
+    typedef wallBoundedStreamLineParticle parcelType;
+
+
+    // Generated Methods
 
         //- No copy construct
         wallBoundedStreamLineParticleCloud
@@ -66,12 +72,6 @@ class wallBoundedStreamLineParticleCloud
         void operator=(const wallBoundedStreamLineParticleCloud&) = delete;
 
 
-public:
-
-    //- Type of parcel the cloud was instantiated for
-    typedef wallBoundedStreamLineParticle parcelType;
-
-
     // Constructors
 
         //- Construct given mesh

src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLineParticleTemplates.C

@@ -36,9 +36,7 @@ bool Foam::wallBoundedStreamLineParticle::move
     const scalar trackTime
 )
 {
-    typename TrackCloudType::particleType& p =
+    auto& p = static_cast<typename TrackCloudType::particleType&>(*this);
-        static_cast<typename TrackCloudType::particleType&>(*this);
-
 
     // Check position is inside tet
     //checkInside();
@@ -49,14 +47,9 @@ bool Foam::wallBoundedStreamLineParticle::move
     scalar tEnd = (1.0 - stepFraction())*trackTime;
     scalar maxDt = mesh().bounds().mag();
 
-    while
+    while (td.keepParticle && !td.switchProcessor && lifeTime_ > 0)
-    (
-        td.keepParticle
-    && !td.switchProcessor
-    && lifeTime_ > 0
-    )
     {
-        // set the lagrangian time-step
+        // Set the lagrangian time-step
         scalar dt = maxDt;
 
         --lifeTime_;
@@ -124,25 +117,19 @@ bool Foam::wallBoundedStreamLineParticle::move
 
         // Transfer particle data into trackingData.
         {
-            //td.allPositions_.append(sampledPositions_);
             td.allPositions_.append(vectorList());
-            vectorList& top = td.allPositions_.last();
+            td.allPositions_.last().transfer(sampledPositions_);
-            top.transfer(sampledPositions_);
         }
 
         forAll(sampledScalars_, i)
         {
-            //td.allScalars_[i].append(sampledScalars_[i]);
             td.allScalars_[i].append(scalarList());
-            scalarList& top = td.allScalars_[i].last();
+            td.allScalars_[i].last().transfer(sampledScalars_[i]);
-            top.transfer(sampledScalars_[i]);
         }
         forAll(sampledVectors_, i)
         {
-            //td.allVectors_[i].append(sampledVectors_[i]);
             td.allVectors_[i].append(vectorList());
-            vectorList& top = td.allVectors_[i].last();
+            td.allVectors_[i].last().transfer(sampledVectors_[i]);
-            top.transfer(sampledVectors_[i]);
         }
     }
 

tutorials/heatTransfer/buoyantBoussinesqPimpleFoam/BenardCells/system/streamlines

@@ -3,7 +3,7 @@
 nLines  24;
 start   (0 0.5 0);
 end     (9 0.5 0);
-fields  (U);
+fields  (p);
 
 #includeEtc "caseDicts/postProcessing/visualization/streamlines.cfg"
 

tutorials/incompressible/pimpleFoam/RAS/ellipsekkLOmega/system/streamLines

@@ -13,25 +13,22 @@ streamLines
     // Time control etc
     ${_visualization};
 
-    setFormat       vtk;
+    setFormat   vtk;
 
-    // Velocity field to use for tracking.
+    // Tracking direction (forward | backward | bidirectional)
-    U               U;
+    direction   forward;
 
-    // Tracked forwards (+U) or backwards (-U)
+    // Fields to sample
-    trackForward    true;
+    fields      (p U);
-
-    // Names of fields to sample. Should contain above velocity field!
-    fields          (p U);
 
     // Steps particles can travel before being removed
-    lifeTime        10000;
+    lifeTime    10000;
 
     // Number of steps per cell (estimate). Set to 1 to disable subcycling.
-    nSubCycle       5;
+    nSubCycle   5;
 
     // Cloud name to use
-    cloud           particleTracks;
+    cloud       particleTracks;
 
     // Seeding method.
     seedSampleSet

tutorials/incompressible/pisoFoam/LES/motorBike/motorBike/system/streamLines

@@ -13,25 +13,22 @@ streamLines
     // Time control etc
     ${_visualization};
 
-    setFormat       vtk; // csv | raw | gnuplot | ensight | xmgr
+    setFormat   vtk;
 
-    // Velocity field to use for tracking.
+    // Tracking direction (forward | backward | bidirectional)
-    U               U;
+    direction   forward;
 
-    // Tracked forwards (+U) or backwards (-U)
+    // Fields to sample
-    trackForward    true;
+    fields      (p U);
-
-    // Names of fields to sample. Should contain above velocity field!
-    fields          (p U);
 
     // Steps particles can travel before being removed
-    lifeTime        10000;
+    lifeTime    10000;
 
     // Number of steps per cell (estimate). Set to 1 to disable subcycling.
-    nSubCycle       5;
+    nSubCycle   5;
 
     // Cloud name to use
-    cloud           particleTracks;
+    cloud       particleTracks;
 
     // Seeding method.
     seedSampleSet

tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOstreamLine

@@ -32,9 +32,6 @@ streamLine1
     nSubCycle       1;
     interpolationScheme cellPoint;
 
-    // Deprecated
-    // trackForward    true;
-
     // Optional (inherited) entries
     region          region0;
     enabled         true;

tutorials/incompressible/simpleFoam/motorBike/system/streamLines

@@ -8,38 +8,35 @@
 
 streamLines
 {
-    // Where to load it from
+    type    streamLine;
-    libs            (fieldFunctionObjects);
+    libs    (fieldFunctionObjects);
-
-    type            streamLine;
 
     // Output every
     writeControl    writeTime;
     // writeInterval 10;
 
-    setFormat       vtk; // csv | raw | gnuplot | ensight
+    setFormat   vtk;
 
-    // Tracked forwards (+U) or backwards (-U)
+    // Tracking direction (forward | backward | bidirectional)
-    trackForward    true;
+    direction   forward;
 
-    // Names of fields to sample. Should contain above velocity field!
+    // Fields to sample
-    fields (p U k);
+    fields      (p U k);
 
     // Steps particles can travel before being removed
-    lifeTime        10000;
+    lifeTime    10000;
 
     //- Specify either absolute length of steps (trackLength) or a number
     //  of subcycling steps per cell (nSubCycle)
 
-        // Size of single track segment [m]
+    // Size of single track segment [m]
-        //trackLength 1e-3;
+    //trackLength 1e-3;
-
-        // Number of steps per cell (estimate). Set to 1 to disable subcycling.
-        nSubCycle 5;
 
+    // Number of steps per cell (estimate). Set to 1 to disable subcycling.
+    nSubCycle   5;
 
     // Cloud name to use
-    cloud           particleTracks;
+    cloud       particleTracks;
 
     // Seeding method.
     seedSampleSet

tutorials/incompressible/simpleFoam/motorBike/system/wallBoundedStreamLines

@@ -9,10 +9,8 @@
 // Interpolate U to create near-wall UNear
 near
 {
-    // Where to load it from
+    type    nearWallFields;
-    libs            (fieldFunctionObjects);
+    libs    (fieldFunctionObjects);
-
-    type nearWallFields;
 
     // Output every
     writeControl    writeTime;
@@ -39,15 +37,16 @@ near
 // Use UNear to track along wall
 wallBoundedStreamLines
 {
-    // Mandatory entries
+    type    wallBoundedStreamLine;
-    type            wallBoundedStreamLine;
+    libs    (fieldFunctionObjects);
-    libs            (fieldFunctionObjects);
+
-    U               UNear;           // Velocity field to use for tracking.
+    U           UNear;           // Velocity field for tracking
-    fields          (p U k UNear);   // Names of fields to sample.
+    fields      (p U k UNear);   // Fields to sample
-    setFormat       vtk;    // raw | gnuplot | xmgr
+    setFormat   vtk;
-    direction       forward;
+    direction   forward;
-    lifeTime        100;    // Steps particles can travel before being removed
+    lifeTime    100;    // Steps particles can travel before being removed
-    cloud           wallBoundedParticleTracks;
+    cloud       wallBoundedParticleTracks;
+
     seedSampleSet
     {
         type        patchSeed;
@@ -80,9 +79,6 @@ wallBoundedStreamLines
     // nSubCycle       1;
     interpolationScheme cellPoint;
 
-    // Deprecated
-    // trackForward    true;
-
     // Optional (inherited) entries
     region          region0;
     enabled         true;

tutorials/incompressible/simpleFoam/pitzDailyExptInlet/system/controlDict

@@ -46,45 +46,7 @@ runTimeModifiable true;
 
 functions
 {
-    streamLines
+    #include "streamLines"
-    {
-        type            streamLine;
-
-        // Where to load it from (if not already in solver)
-        libs            (fieldFunctionObjects);
-
-        // Output every
-        writeControl    writeTime;
-        // writeInterval 10;
-
-        setFormat       vtk; // csv | raw | gnuplot | ensight | xmgr
-
-        // Tracked forwards (+U) or backwards (-U)
-        trackForward    true;
-
-        // Names of fields to sample. Should contain above velocity field!
-        fields          (p k U);
-
-        // Steps particles can travel before being removed
-        lifeTime        10000;
-
-        // Number of steps per cell (estimate). Set to 1 to disable subcycling.
-        nSubCycle       5;
-
-        // Cloud name to use
-        cloud           particleTracks;
-
-        // Seeding method.
-        seedSampleSet
-        {
-            type        uniform;
-
-            axis        x;  //distance;
-            start       (-0.0205 0.001  0.00001);
-            end         (-0.0205 0.0251 0.00001);
-            nPoints     10;
-        }
-    }
 }
 
 

tutorials/incompressible/simpleFoam/pitzDailyExptInlet/system/streamLines

@@ -0,0 +1,41 @@
+// -*- C++ -*-
+
+streamLines
+{
+    type    streamLine;
+    libs    (fieldFunctionObjects);
+
+    writeControl    writeTime;
+    // writeInterval 10;
+
+    setFormat   vtk;
+
+    // Tracking direction (forward | backward | bidirectional)
+    direction   forward;
+
+    // Fields to sample
+    fields      (p k U);
+
+    // Steps particles can travel before being removed
+    lifeTime    10000;
+
+    // Number of steps per cell (estimate). Set to 1 to disable subcycling.
+    nSubCycle   5;
+
+    // Cloud name to use
+    cloud       particleTracks;
+
+    // Seeding method.
+    seedSampleSet
+    {
+        type        uniform;
+
+        axis        x;  //distance;
+        start       (-0.0205 0.001  0.00001);
+        end         (-0.0205 0.0251 0.00001);
+        nPoints     10;
+    }
+}
+
+
+// ************************************************************************* //

tutorials/incompressible/simpleFoam/windAroundBuildings/system/streamLines

@@ -9,25 +9,22 @@ streamLines
     // Time control etc
     ${_visualization};
 
-    setFormat       vtk;
+    setFormat   vtk;
 
-    // Velocity field to use for tracking.
+    // Tracking direction (forward | backward | bidirectional)
-    U               U;
+    direction   forward;
 
-    // Tracked forwards (+U) or backwards (-U)
+    // Fields to sample
-    trackForward    true;
+    fields      (p U);
-
-    // Names of fields to sample. Should contain above velocity field!
-    fields          (p U);
 
     // Steps particles can travel before being removed
-    lifeTime        10000;
+    lifeTime    10000;
 
     // Number of steps per cell (estimate). Set to 1 to disable subcycling.
-    nSubCycle       5;
+    nSubCycle   5;
 
     // Cloud name to use
-    cloud           particleTracks;
+    cloud       particleTracks;
 
     // Seeding method.
     seedSampleSet