From 9abbe4d31d9e84d2e50e2ff1793d0955b94e9fc8 Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Mon, 27 Jun 2016 20:44:11 +0100
Subject: [PATCH] utilities particleTracks, steadyParticleTracks: Updated and
 corrected

---
 .../lagrangian/particleTracks/Make/files      |  0
 .../lagrangian/particleTracks/Make/options    |  0
 .../lagrangian/particleTracks/createFields.H  |  5 --
 .../particleTracks/particleTrackProperties    |  0
 .../particleTracks/particleTracks.C           | 19 +++---
 .../steadyParticleTracks/Make/files           |  0
 .../steadyParticleTracks/Make/options         |  0
 .../steadyParticleTracks/createFields.H       |  0
 .../steadyParticleTracks/particleTrackDict    |  0
 .../steadyParticleTracks.C                    | 15 +++--
 .../steadyParticleTracksTemplates.C           | 20 ++----
 .../steadyParticleTracksTemplates.H           | 64 ++++++++++---------
 12 files changed, 56 insertions(+), 67 deletions(-)
 rename applications/utilities/postProcessing/{toBeFunctionObjects => }/lagrangian/particleTracks/Make/files (100%)
 rename applications/utilities/postProcessing/{toBeFunctionObjects => }/lagrangian/particleTracks/Make/options (100%)
 rename applications/utilities/postProcessing/{toBeFunctionObjects => }/lagrangian/particleTracks/createFields.H (71%)
 rename applications/utilities/postProcessing/{toBeFunctionObjects => }/lagrangian/particleTracks/particleTrackProperties (100%)
 rename applications/utilities/postProcessing/{toBeFunctionObjects => }/lagrangian/particleTracks/particleTracks.C (94%)
 rename applications/utilities/postProcessing/{toBeFunctionObjects => }/lagrangian/steadyParticleTracks/Make/files (100%)
 rename applications/utilities/postProcessing/{toBeFunctionObjects => }/lagrangian/steadyParticleTracks/Make/options (100%)
 rename applications/utilities/postProcessing/{toBeFunctionObjects => }/lagrangian/steadyParticleTracks/createFields.H (100%)
 rename applications/utilities/postProcessing/{toBeFunctionObjects => }/lagrangian/steadyParticleTracks/particleTrackDict (100%)
 rename applications/utilities/postProcessing/{toBeFunctionObjects => }/lagrangian/steadyParticleTracks/steadyParticleTracks.C (96%)
 rename applications/utilities/postProcessing/{toBeFunctionObjects => }/lagrangian/steadyParticleTracks/steadyParticleTracksTemplates.C (92%)
 rename applications/utilities/postProcessing/{toBeFunctionObjects => }/lagrangian/steadyParticleTracks/steadyParticleTracksTemplates.H (69%)

diff --git a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/particleTracks/Make/files b/applications/utilities/postProcessing/lagrangian/particleTracks/Make/files
similarity index 100%
rename from applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/particleTracks/Make/files
rename to applications/utilities/postProcessing/lagrangian/particleTracks/Make/files
diff --git a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/particleTracks/Make/options b/applications/utilities/postProcessing/lagrangian/particleTracks/Make/options
similarity index 100%
rename from applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/particleTracks/Make/options
rename to applications/utilities/postProcessing/lagrangian/particleTracks/Make/options
diff --git a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/particleTracks/createFields.H b/applications/utilities/postProcessing/lagrangian/particleTracks/createFields.H
similarity index 71%
rename from applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/particleTracks/createFields.H
rename to applications/utilities/postProcessing/lagrangian/particleTracks/createFields.H
index 01d9e6813f..78738e321d 100644
--- a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/particleTracks/createFields.H
+++ b/applications/utilities/postProcessing/lagrangian/particleTracks/createFields.H
@@ -13,11 +13,6 @@ const word cloudName(propsDict.lookup("cloudName"));
 
 label sampleFrequency(readLabel(propsDict.lookup("sampleFrequency")));
 
-// outputMode: compositeFile, filePerTrack
-//word outputmode(propsDict.lookup("outputMode"))
-
 label maxPositions(readLabel(propsDict.lookup("maxPositions")));
 
-// outputFormat: raw, vtk
-//word outputFormat(propsDict.lookup("outputFormat"));
 word setFormat(propsDict.lookupOrDefault<word>("setFormat", "vtk"));
diff --git a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/particleTracks/particleTrackProperties b/applications/utilities/postProcessing/lagrangian/particleTracks/particleTrackProperties
similarity index 100%
rename from applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/particleTracks/particleTrackProperties
rename to applications/utilities/postProcessing/lagrangian/particleTracks/particleTrackProperties
diff --git a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/particleTracks/particleTracks.C b/applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C
similarity index 94%
rename from applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/particleTracks/particleTracks.C
rename to applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C
index b7f8654dac..4812b7d92a 100644
--- a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/particleTracks/particleTracks.C
+++ b/applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C
@@ -72,6 +72,7 @@ int main(int argc, char *argv[])
 
         Info<< "    Reading particle positions" << endl;
         passiveParticleCloud myCloud(mesh, cloudName);
+
         Info<< "    Read " << returnReduce(myCloud.size(), sumOp<label>())
             << " particles" << endl;
 
@@ -82,7 +83,6 @@ int main(int argc, char *argv[])
 
             if (origProc >= maxIds.size())
             {
-                // Expand size
                 maxIds.setSize(origProc+1, -1);
             }
 
@@ -111,7 +111,7 @@ int main(int argc, char *argv[])
     Info<< nl << endl;
 
 
-    // calc starting ids for particles on each processor
+    // Calculate starting ids for particles on each processor
     List<label> startIds(numIds.size(), 0);
     for (label i = 0; i < numIds.size()-1; i++)
     {
@@ -120,11 +120,10 @@ int main(int argc, char *argv[])
     label nParticle = startIds.last() + numIds[startIds.size()-1];
 
 
-
-    // number of tracks to generate
+    // Number of tracks to generate
     label nTracks = nParticle/sampleFrequency;
 
-    // storage for all particle tracks
+    // Storage for all particle tracks
     List<DynamicList<vector>> allTracks(nTracks);
 
     Info<< "\nGenerating " << nTracks << " particle tracks for cloud "
@@ -143,7 +142,7 @@ int main(int argc, char *argv[])
         Info<< "    Reading particle positions" << endl;
         passiveParticleCloud myCloud(mesh, cloudName);
 
-        // collect the track data on all processors that have positions
+        // Collect the track data on all processors that have positions
         allPositions[Pstream::myProcNo()].setSize
         (
             myCloud.size(),
@@ -161,7 +160,7 @@ int main(int argc, char *argv[])
             i++;
         }
 
-        // collect the track data on the master processor
+        // Collect the track data on the master processor
         Pstream::gatherList(allPositions);
         Pstream::gatherList(allOrigIds);
         Pstream::gatherList(allOrigProcs);
@@ -228,18 +227,16 @@ int main(int argc, char *argv[])
 
         OFstream vtkTracks
         (
-            vtkPath
-          / "particleTracks." + vtkFile.ext()
+            vtkPath/("particleTracks." + vtkFile.ext())
         );
 
         Info<< "\nWriting particle tracks in " << setFormat
             << " format to " << vtkTracks.name()
             << nl << endl;
 
-
         scalarFormatterPtr().write
         (
-            true,           // writeTracks
+            true,
             tracks,
             wordList(0),
             List<List<scalarField>>(0),
diff --git a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/Make/files b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/Make/files
similarity index 100%
rename from applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/Make/files
rename to applications/utilities/postProcessing/lagrangian/steadyParticleTracks/Make/files
diff --git a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/Make/options b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/Make/options
similarity index 100%
rename from applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/Make/options
rename to applications/utilities/postProcessing/lagrangian/steadyParticleTracks/Make/options
diff --git a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/createFields.H b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/createFields.H
similarity index 100%
rename from applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/createFields.H
rename to applications/utilities/postProcessing/lagrangian/steadyParticleTracks/createFields.H
diff --git a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/particleTrackDict b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/particleTrackDict
similarity index 100%
rename from applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/particleTrackDict
rename to applications/utilities/postProcessing/lagrangian/steadyParticleTracks/particleTrackDict
diff --git a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/steadyParticleTracks.C b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C
similarity index 96%
rename from applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/steadyParticleTracks.C
rename to applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C
index cc34e01691..475974ced5 100644
--- a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/steadyParticleTracks.C
+++ b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C
@@ -141,7 +141,7 @@ int main(int argc, char *argv[])
 
         PtrList<passiveParticle> particles(0);
 
-        // transfer particles to (more convenient) list
+        // Transfer particles to (more convenient) list
         {
             passiveParticleCloud ppc(mesh, cloudName);
             Info<< "\n    Read " << returnReduce(ppc.size(), sumOp<label>())
@@ -193,7 +193,7 @@ int main(int argc, char *argv[])
         {
             Info<< "\n    Generating " << nTracks << " tracks" << endl;
 
-            // determine length of each track
+            // Determine length of each track
             labelList trackLengths(nTracks, 0);
             forAll(particleToTrack, i)
             {
@@ -201,7 +201,7 @@ int main(int argc, char *argv[])
                 trackLengths[trackI]++;
             }
 
-            // particle "age" property used to sort the tracks
+            // Particle "age" property used to sort the tracks
             List<SortableList<scalar>> agePerTrack(nTracks);
             List<List<label>> particleMap(nTracks);
 
@@ -212,7 +212,7 @@ int main(int argc, char *argv[])
                 particleMap[i].setSize(length);
             }
 
-            // store the particle age per track
+            // Store the particle age per track
             IOobjectList cloudObjs
             (
                 mesh,
@@ -224,8 +224,11 @@ int main(int argc, char *argv[])
             {
                 tmp<scalarField> tage =
                     readParticleField<scalar>("age", cloudObjs);
+
                 const scalarField& age = tage();
+
                 List<label> trackSamples(nTracks, 0);
+
                 forAll(particleToTrack, i)
                 {
                     const label trackI = particleToTrack[i];
@@ -263,7 +266,7 @@ int main(int argc, char *argv[])
                         labelList& particleIds = particleMap[i];
 
                         {
-                            // update addressing
+                            // Update addressing
                             List<label> sortedIds(ids);
                             forAll(sortedIds, j)
                             {
@@ -283,7 +286,7 @@ int main(int argc, char *argv[])
                 }
 
 
-                // write track (line) connectivity to file
+                // Write track (line) connectivity to file
 
                 Info<< "\n    Writing track lines" << endl;
                 os  << "\nLINES " << nTracks << ' ' << nPoints + nTracks << nl;
diff --git a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/steadyParticleTracksTemplates.C b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracksTemplates.C
similarity index 92%
rename from applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/steadyParticleTracksTemplates.C
rename to applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracksTemplates.C
index 1508bb6fe6..30cfd66590 100644
--- a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/steadyParticleTracksTemplates.C
+++ b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracksTemplates.C
@@ -27,13 +27,8 @@ License
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
-namespace Foam
-{
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
 template<class Type>
-bool fieldOk(const IOobjectList& cloudObjs, const word& name)
+bool Foam::fieldOk(const IOobjectList& cloudObjs, const word& name)
 {
     IOobjectList objects(cloudObjs.lookupClass(IOField<Type>::typeName));
 
@@ -42,7 +37,7 @@ bool fieldOk(const IOobjectList& cloudObjs, const word& name)
 
 
 template<class Type>
-tmp<Field<Type>> readParticleField
+Foam::tmp<Foam::Field<Type>> Foam::readParticleField
 (
     const word& name,
     const IOobjectList cloudObjs
@@ -66,7 +61,7 @@ tmp<Field<Type>> readParticleField
 
 
 template<class Type>
-void readFields
+void Foam::readFields
 (
     PtrList<List<Type>>& values,
     const List<word>& fieldNames,
@@ -95,7 +90,7 @@ void readFields
 
 
 template<class Type>
-void writeVTK(OFstream& os, const Type& value)
+void Foam::writeVTK(OFstream& os, const Type& value)
 {
     os  << value.component(0);
     for (label i=1; i<pTraits<Type>::nComponents; i++)
@@ -106,7 +101,7 @@ void writeVTK(OFstream& os, const Type& value)
 
 
 template<class Type>
-void writeVTKFields
+void Foam::writeVTKFields
 (
     OFstream& os,
     const PtrList<List<Type>>& values,
@@ -147,7 +142,7 @@ void writeVTKFields
 
 
 template<class Type>
-void processFields
+void Foam::processFields
 (
     OFstream& os,
     const List<List<label>>& addr,
@@ -183,8 +178,5 @@ void processFields
     }
 }
 
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-} // End namespace Foam
 
 // ************************************************************************* //
diff --git a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/steadyParticleTracksTemplates.H b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracksTemplates.H
similarity index 69%
rename from applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/steadyParticleTracksTemplates.H
rename to applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracksTemplates.H
index 46c6ba91b3..a68f1da9b7 100644
--- a/applications/utilities/postProcessing/toBeFunctionObjects/lagrangian/steadyParticleTracks/steadyParticleTracksTemplates.H
+++ b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracksTemplates.H
@@ -39,42 +39,44 @@ namespace Foam
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
-    bool fieldOk(const IOobjectList& cloudObjs, const word& name);
+template<class Type>
+bool fieldOk(const IOobjectList& cloudObjs, const word& name);
 
-    template<class Type>
-    tmp<Field<Type>> readParticleField
-    (
-        const word& name,
-        const IOobjectList cloudObjs
-    );
+template<class Type>
+tmp<Field<Type>> readParticleField
+(
+    const word& name,
+    const IOobjectList cloudObjs
+);
 
-    template<class Type>
-    void readFields
-    (
-        PtrList<List<Type>>& values,
-        const List<word>& fields,
-        const IOobjectList& cloudObjs
-    );
+template<class Type>
+void readFields
+(
+    PtrList<List<Type>>& values,
+    const List<word>& fields,
+    const IOobjectList& cloudObjs
+);
 
-    template<class Type>
-    void writeVTK(OFstream& os, const Type& value);
+template<class Type>
+void writeVTK(OFstream& os, const Type& value);
 
-    template<class Type>
-    void writeVTKFields
-    (
-        OFstream& os,
-        const PtrList<List<Type>>& values,
-        const List<SortableList<scalar>>& agePerTrack,
-        const List<word>& fieldNames
-    );
+template<class Type>
+void writeVTKFields
+(
+    OFstream& os,
+    const PtrList<List<Type>>& values,
+    const List<List<label>>& addr,
+    const List<word>& fieldNames
+);
 
-    void processFields
-    (
-        OFstream& os,
-        const List<SortableList<scalar>>& agePerTrack,
-        const List<word>& userFieldNames,
-        const IOobjectList& cloudObjs
-    );
+template<class Type>
+void processFields
+(
+    OFstream& os,
+    const List<SortableList<scalar>>& agePerTrack,
+    const List<word>& userFieldNames,
+    const IOobjectList& cloudObjs
+);
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //