functionObjects: rewritten to all be derived from 'functionObject'

- Avoids the need for the 'OutputFilterFunctionObject' wrapper
  - Time-control for execution and writing is now provided by the
    'timeControlFunctionObject' which instantiates the processing
    'functionObject' and controls its operation.
  - Alternative time-control functionObjects can now be written and
    selected at run-time without the need to compile wrapped version of
    EVERY existing functionObject which would have been required in the
    old structure.
  - The separation of 'execute' and 'write' functions is now formalized in the
    'functionObject' base-class and all derived classes implement the
    two functions.
  - Unnecessary implementations of functions with appropriate defaults
    in the 'functionObject' base-class have been removed reducing
    clutter and simplifying implementation of new functionObjects.
  - The 'coded' 'functionObject' has also been updated, simplified and tested.
  - Further simplification is now possible by creating some general
    intermediate classes derived from 'functionObject'.

src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.C

@@ -38,6 +38,7 @@ License
 #include "meshSearchMeshObject.H"
 #include "faceSet.H"
 #include "mapPolyMesh.H"
+#include "addToRunTimeSelectionTable.H"
 
 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
@@ -46,6 +47,13 @@ namespace Foam
 namespace functionObjects
 {
     defineTypeNameAndDebug(wallBoundedStreamLine, 0);
+
+    addToRunTimeSelectionTable
+    (
+        functionObject,
+        wallBoundedStreamLine,
+        dictionary
+    );
 }
 }
 
@@ -162,7 +170,6 @@ Foam::tetIndices Foam::functionObjects::wallBoundedStreamLine::findNearestTet
 
 void Foam::functionObjects::wallBoundedStreamLine::track()
 {
-    const Time& runTime = obr_.time();
     const fvMesh& mesh = dynamic_cast<const fvMesh&>(obr_);
 
 
@@ -250,118 +257,77 @@ void Foam::functionObjects::wallBoundedStreamLine::track()
 
     label UIndex = -1;
 
-    if (loadFromFiles_)
+    label nScalar = 0;
+    label nVector = 0;
+
+    forAll(fields_, i)
     {
-        IOobjectList allObjects(mesh, runTime.timeName());
-
-        IOobjectList objects(2*fields_.size());
-        forAll(fields_, i)
+        if (mesh.foundObject<volScalarField>(fields_[i]))
         {
-            objects.add(*allObjects[fields_[i]]);
+            nScalar++;
         }
-
-        ReadFields(mesh, objects, vsFlds);
-        vsInterp.setSize(vsFlds.size());
-        forAll(vsFlds, i)
+        else if (mesh.foundObject<volVectorField>(fields_[i]))
         {
+            nVector++;
+        }
+        else
+        {
+            FatalErrorInFunction
+                << "Cannot find field " << fields_[i] << endl
+                << "Valid scalar fields are:"
+                << mesh.names(volScalarField::typeName) << endl
+                << "Valid vector fields are:"
+                << mesh.names(volVectorField::typeName)
+                << exit(FatalError);
+        }
+    }
+
+    vsInterp.setSize(nScalar);
+    nScalar = 0;
+    vvInterp.setSize(nVector);
+    nVector = 0;
+
+    forAll(fields_, i)
+    {
+        if (mesh.foundObject<volScalarField>(fields_[i]))
+        {
+            const volScalarField& f = mesh.lookupObject<volScalarField>
+            (
+                fields_[i]
+            );
             vsInterp.set
             (
-                i,
+                nScalar++,
                 interpolation<scalar>::New
                 (
                     interpolationScheme_,
-                    vsFlds[i]
+                    f
                 )
             );
         }
-        ReadFields(mesh, objects, vvFlds);
-        vvInterp.setSize(vvFlds.size());
-        forAll(vvFlds, i)
+        else if (mesh.foundObject<volVectorField>(fields_[i]))
         {
+            const volVectorField& f = mesh.lookupObject<volVectorField>
+            (
+                fields_[i]
+            );
+
+            if (f.name() == UName_)
+            {
+                UIndex = nVector;
+            }
+
             vvInterp.set
             (
-                i,
+                nVector++,
                 interpolation<vector>::New
                 (
                     interpolationScheme_,
-                    vvFlds[i]
+                    f
                 )
             );
         }
     }
-    else
-    {
-        label nScalar = 0;
-        label nVector = 0;
-
-        forAll(fields_, i)
-        {
-            if (mesh.foundObject<volScalarField>(fields_[i]))
-            {
-                nScalar++;
-            }
-            else if (mesh.foundObject<volVectorField>(fields_[i]))
-            {
-                nVector++;
-            }
-            else
-            {
-                FatalErrorInFunction
-                    << "Cannot find field " << fields_[i] << endl
-                    << "Valid scalar fields are:"
-                    << mesh.names(volScalarField::typeName) << endl
-                    << "Valid vector fields are:"
-                    << mesh.names(volVectorField::typeName)
-                    << exit(FatalError);
-            }
-        }
-        vsInterp.setSize(nScalar);
-        nScalar = 0;
-        vvInterp.setSize(nVector);
-        nVector = 0;
-
-        forAll(fields_, i)
-        {
-            if (mesh.foundObject<volScalarField>(fields_[i]))
-            {
-                const volScalarField& f = mesh.lookupObject<volScalarField>
-                (
-                    fields_[i]
-                );
-                vsInterp.set
-                (
-                    nScalar++,
-                    interpolation<scalar>::New
-                    (
-                        interpolationScheme_,
-                        f
-                    )
-                );
-            }
-            else if (mesh.foundObject<volVectorField>(fields_[i]))
-            {
-                const volVectorField& f = mesh.lookupObject<volVectorField>
-                (
-                    fields_[i]
-                );
-
-                if (f.name() == UName_)
-                {
-                    UIndex = nVector;
-                }
-
-                vvInterp.set
-                (
-                    nVector++,
-                    interpolation<vector>::New
-                    (
-                        interpolationScheme_,
-                        f
-                    )
-                );
-            }
-        }
-    }
 
     // Store the names
     scalarNames_.setSize(vsInterp.size());
@@ -439,17 +405,21 @@ void Foam::functionObjects::wallBoundedStreamLine::track()
 Foam::functionObjects::wallBoundedStreamLine::wallBoundedStreamLine
 (
     const word& name,
-    const objectRegistry& obr,
-    const dictionary& dict,
-    const bool loadFromFiles
+    const Time& runTime,
+    const dictionary& dict
 )
 :
-    dict_(dict),
-    name_(name),
-    obr_(obr),
-    loadFromFiles_(loadFromFiles)
+    functionObject(name),
+    obr_
+    (
+        runTime.lookupObject<objectRegistry>
+        (
+            dict.lookupOrDefault("region", polyMesh::defaultRegion)
+        )
+    ),
+    dict_(dict)
 {
-    if (!isA<fvMesh>(obr))
+    if (!isA<fvMesh>(obr_))
     {
         FatalErrorInFunction
             << "objectRegistry is not an fvMesh" << exit(FatalError);
@@ -467,7 +437,7 @@ Foam::functionObjects::wallBoundedStreamLine::~wallBoundedStreamLine()
 
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
-void Foam::functionObjects::wallBoundedStreamLine::read(const dictionary& dict)
+bool Foam::functionObjects::wallBoundedStreamLine::read(const dictionary& dict)
 {
     //dict_ = dict;
     dict.lookup("fields") >> fields_;
@@ -613,22 +583,21 @@ void Foam::functionObjects::wallBoundedStreamLine::read(const dictionary& dict)
             }
         }
     }
+
+    return true;
 }
 
 
-void Foam::functionObjects::wallBoundedStreamLine::execute()
-{}
+bool Foam::functionObjects::wallBoundedStreamLine::execute
+(
+    const bool postProcess
+)
+{
+    return true;
+}
 
 
-void Foam::functionObjects::wallBoundedStreamLine::end()
-{}
-
-
-void Foam::functionObjects::wallBoundedStreamLine::timeSet()
-{}
-
-
-void Foam::functionObjects::wallBoundedStreamLine::write()
+bool Foam::functionObjects::wallBoundedStreamLine::write(const bool postProcess)
 {
     const Time& runTime = obr_.time();
     const fvMesh& mesh = dynamic_cast<const fvMesh&>(obr_);
@@ -680,44 +649,57 @@ void Foam::functionObjects::wallBoundedStreamLine::write()
             recvMap.xfer()
         );
 
-
         // Distribute the track positions. Note: use scheduled comms
         // to prevent buffering.
-        mapDistribute::distribute
+        allTracks_.shrink();
+        mapDistributeBase::distribute
         (
             Pstream::scheduled,
             distMap.schedule(),
             distMap.constructSize(),
             distMap.subMap(),
+            false,
             distMap.constructMap(),
-            allTracks_
+            false,
+            allTracks_,
+            flipOp()
         );
 
         // Distribute the scalars
         forAll(allScalars_, scalarI)
         {
-            mapDistribute::distribute
+            allScalars_[scalarI].shrink();
+            mapDistributeBase::distribute
             (
                 Pstream::scheduled,
                 distMap.schedule(),
                 distMap.constructSize(),
                 distMap.subMap(),
+                false,
                 distMap.constructMap(),
-                allScalars_[scalarI]
+                false,
+                allScalars_[scalarI],
+                flipOp()
             );
+            allScalars_[scalarI].setCapacity(allScalars_[scalarI].size());
         }
         // Distribute the vectors
         forAll(allVectors_, vectorI)
         {
-            mapDistribute::distribute
+            allVectors_[vectorI].shrink();
+            mapDistributeBase::distribute
             (
                 Pstream::scheduled,
                 distMap.schedule(),
                 distMap.constructSize(),
                 distMap.subMap(),
+                false,
                 distMap.constructMap(),
-                allVectors_[vectorI]
+                false,
+                allVectors_[vectorI],
+                flipOp()
             );
+            allVectors_[vectorI].setCapacity(allVectors_[vectorI].size());
         }
     }
 
@@ -850,6 +832,8 @@ void Foam::functionObjects::wallBoundedStreamLine::write()
             );
         }
     }
+
+    return true;
 }