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/sampling/sampledSet/sampledSets/sampledSets.C

@@ -31,6 +31,7 @@ License
 #include "SortableList.H"
 #include "volPointInterpolation.H"
 #include "mapPolyMesh.H"
+#include "addToRunTimeSelectionTable.H"
 
 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
@@ -38,9 +39,16 @@ namespace Foam
 {
     defineTypeNameAndDebug(sampledSets, 0);
 
-    bool sampledSets::verbose_ = false;
+    addToRunTimeSelectionTable
+    (
+        functionObject,
+        sampledSets,
+        dictionary
+    );
 }
 
+bool Foam::sampledSets::verbose_ = false;
+
 
 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
 
@@ -130,6 +138,48 @@ void Foam::sampledSets::combineSampledSets
 
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
+Foam::sampledSets::sampledSets
+(
+    const word& name,
+    const Time& t,
+    const dictionary& dict
+)
+:
+    functionObject(name),
+    PtrList<sampledSet>(),
+    mesh_
+    (
+        refCast<const fvMesh>
+        (
+            t.lookupObject<objectRegistry>
+            (
+                dict.lookupOrDefault("region", polyMesh::defaultRegion)
+            )
+        )
+    ),
+    loadFromFiles_(false),
+    outputPath_(fileName::null),
+    searchEngine_(mesh_),
+    interpolationScheme_(word::null),
+    writeFormat_(word::null)
+{
+    if (Pstream::parRun())
+    {
+        outputPath_ = mesh_.time().path()/".."/"postProcessing"/name;
+    }
+    else
+    {
+        outputPath_ = mesh_.time().path()/"postProcessing"/name;
+    }
+    if (mesh_.name() != fvMesh::defaultRegion)
+    {
+        outputPath_ = outputPath_/mesh_.name();
+    }
+
+    read(dict);
+}
+
+
 Foam::sampledSets::sampledSets
 (
     const word& name,
@@ -138,8 +188,8 @@ Foam::sampledSets::sampledSets
     const bool loadFromFiles
 )
 :
+    functionObject(name),
     PtrList<sampledSet>(),
-    name_(name),
     mesh_(refCast<const fvMesh>(obr)),
     loadFromFiles_(loadFromFiles),
     outputPath_(fileName::null),
@@ -149,11 +199,11 @@ Foam::sampledSets::sampledSets
 {
     if (Pstream::parRun())
     {
-        outputPath_ = mesh_.time().path()/".."/"postProcessing"/name_;
+        outputPath_ = mesh_.time().path()/".."/"postProcessing"/name;
     }
     else
     {
-        outputPath_ = mesh_.time().path()/"postProcessing"/name_;
+        outputPath_ = mesh_.time().path()/"postProcessing"/name;
     }
     if (mesh_.name() != fvMesh::defaultRegion)
     {
@@ -178,19 +228,13 @@ void Foam::sampledSets::verbose(const bool verbosity)
 }
 
 
-void Foam::sampledSets::execute()
-{}
+bool Foam::sampledSets::execute(const bool postProcess)
+{
+    return true;
+}
 
 
-void Foam::sampledSets::end()
-{}
-
-
-void Foam::sampledSets::timeSet()
-{}
-
-
-void Foam::sampledSets::write()
+bool Foam::sampledSets::write(const bool postProcess)
 {
     if (size())
     {
@@ -230,10 +274,12 @@ void Foam::sampledSets::write()
             sampleAndWrite(tensorFields_);
         }
     }
+
+    return true;
 }
 
 
-void Foam::sampledSets::read(const dictionary& dict)
+bool Foam::sampledSets::read(const dictionary& dict)
 {
     dict_ = dict;
 
@@ -276,6 +322,8 @@ void Foam::sampledSets::read(const dictionary& dict)
         }
         Pout<< ")" << endl;
     }
+
+    return true;
 }
 
 

src/sampling/sampledSet/sampledSets/sampledSets.H

@@ -36,6 +36,7 @@ SourceFiles
 #ifndef sampledSets_H
 #define sampledSets_H
 
+#include "functionObject.H"
 #include "sampledSet.H"
 #include "volFieldsFwd.H"
 #include "meshSearch.H"
@@ -49,6 +50,8 @@ SourceFiles
 namespace Foam
 {
 
+// Forward declaration of classes
+class Time;
 class objectRegistry;
 class dictionary;
 class fvMesh;
@@ -59,6 +62,7 @@ class fvMesh;
 
 class sampledSets
 :
+    public functionObject,
     public PtrList<sampledSet>
 {
     // Private classes
@@ -153,10 +157,6 @@ class sampledSets
 
     // Private data
 
-        //- Name of this set of sets,
-        //  Also used as the name of the sampledSets directory.
-        word name_;
-
         //- Const reference to fvMesh
         const fvMesh& mesh_;
 
@@ -256,6 +256,14 @@ public:
 
     // Constructors
 
+        //- Construct from Time and dictionary
+        sampledSets
+        (
+            const word& name,
+            const Time& time,
+            const dictionary& dict
+        );
+
         //- Construct for given objectRegistry and dictionary
         //  allow the possibility to load fields from files
         sampledSets
@@ -273,29 +281,17 @@ public:
 
     // Member Functions
 
-        //- Return name of the set of probes
-        virtual const word& name() const
-        {
-            return name_;
-        }
-
         //- Set verbosity level
         void verbose(const bool verbosity = true);
 
+        //- Read the sampledSets
+        virtual bool read(const dictionary&);
+
         //- Execute, currently does nothing
-        virtual void execute();
-
-        //- Execute at the final time-loop, currently does nothing
-        virtual void end();
-
-        //- Called when time was set at the end of the Time::operator++
-        virtual void timeSet();
+        virtual bool execute(const bool postProcess = false);
 
         //- Sample and write
-        virtual void write();
-
-        //- Read the sampledSets
-        virtual void read(const dictionary&);
+        virtual bool write(const bool postProcess = false);
 
         //- Correct for mesh changes
         void correct();