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/regionSizeDistribution/regionSizeDistribution.C

@@ -24,11 +24,8 @@ License
 \*---------------------------------------------------------------------------*/
 
 #include "regionSizeDistribution.H"
-#include "volFields.H"
-#include "regionSplit.H"
 #include "fvcVolumeIntegrate.H"
-#include "mathematicalConstants.H"
-#include "stringListOps.H"
+#include "addToRunTimeSelectionTable.H"
 
 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
@@ -37,6 +34,13 @@ namespace Foam
     namespace functionObjects
     {
         defineTypeNameAndDebug(regionSizeDistribution, 0);
+
+        addToRunTimeSelectionTable
+        (
+            functionObject,
+            regionSizeDistribution,
+            dictionary
+        );
     }
 
     //- Plus op for FixedList<scalar>
@@ -322,18 +326,15 @@ void Foam::functionObjects::regionSizeDistribution::writeGraphs
 Foam::functionObjects::regionSizeDistribution::regionSizeDistribution
 (
     const word& name,
-    const objectRegistry& obr,
-    const dictionary& dict,
-    const bool loadFromFiles
+    const Time& runTime,
+    const dictionary& dict
 )
 :
-    functionObjectFiles(obr, name, typeName),
-    name_(name),
-    obr_(obr),
+    writeFile(name, runTime, dict, name),
     alphaName_(dict.lookup("field")),
     patchNames_(dict.lookup("patches"))
 {
-    if (!isA<fvMesh>(obr))
+    if (!isA<fvMesh>(obr_))
     {
         FatalErrorInFunction
             << "objectRegistry is not an fvMesh" << exit(FatalError);
@@ -351,7 +352,7 @@ Foam::functionObjects::regionSizeDistribution::~regionSizeDistribution()
 
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
-void Foam::functionObjects::regionSizeDistribution::read(const dictionary& dict)
+bool Foam::functionObjects::regionSizeDistribution::read(const dictionary& dict)
 {
     dict.lookup("field") >> alphaName_;
     dict.lookup("patches") >> patchNames_;
@@ -372,24 +373,26 @@ void Foam::functionObjects::regionSizeDistribution::read(const dictionary& dict)
         Info<< "Transforming all vectorFields with coordinate system "
             << coordSysPtr_().name() << endl;
     }
+
+    return true;
 }
 
 
-void Foam::functionObjects::regionSizeDistribution::execute()
-{}
-
-
-void Foam::functionObjects::regionSizeDistribution::end()
-{}
-
-
-void Foam::functionObjects::regionSizeDistribution::timeSet()
-{}
-
-
-void Foam::functionObjects::regionSizeDistribution::write()
+bool Foam::functionObjects::regionSizeDistribution::execute
+(
+    const bool postProcess
+)
 {
-    Info<< type() << " " << name_ << " output:" << nl;
+    return true;
+}
+
+
+bool Foam::functionObjects::regionSizeDistribution::write
+(
+    const bool postProcess
+)
+{
+    Info<< type() << " " << name() << " output:" << nl;
 
     const fvMesh& mesh = refCast<const fvMesh>(obr_);
 
@@ -846,6 +849,8 @@ void Foam::functionObjects::regionSizeDistribution::write()
             }
         }
     }
+
+    return true;
 }
 
 

src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H

@@ -96,7 +96,7 @@ Description
 
 SeeAlso
     Foam::functionObject
-    Foam::OutputFilterFunctionObject
+    Foam::functionObjects::writeFile
 
 SourceFiles
     regionSizeDistribution.C
@@ -106,8 +106,7 @@ SourceFiles
 #ifndef functionObjects_regionSizeDistribution_H
 #define functionObjects_regionSizeDistribution_H
 
-#include "functionObjectFiles.H"
-#include "pointFieldFwd.H"
+#include "writeFile.H"
 #include "writer.H"
 #include "Map.H"
 #include "volFieldsFwd.H"
@@ -121,10 +120,7 @@ namespace Foam
 
 // Forward declaration of classes
 class objectRegistry;
-class dictionary;
-class mapPolyMesh;
 class regionSplit;
-class polyMesh;
 
 namespace functionObjects
 {
@@ -135,15 +131,10 @@ namespace functionObjects
 
 class regionSizeDistribution
 :
-    public functionObjectFiles
+    public writeFile
 {
     // Private data
 
-        //- Name of this set of regionSizeDistribution objects
-        word name_;
-
-        const objectRegistry& obr_;
-
         //- Name of field
         word alphaName_;
 
@@ -250,9 +241,8 @@ public:
         regionSizeDistribution
         (
             const word& name,
-            const objectRegistry&,
-            const dictionary&,
-            const bool loadFromFiles = false
+            const Time& runTime,
+            const dictionary&
         );
 
 
@@ -263,34 +253,14 @@ public:
 
     // Member Functions
 
-        //- Return name of the set of regionSizeDistribution
-        virtual const word& name() const
-        {
-            return name_;
-        }
-
         //- Read the regionSizeDistribution data
-        virtual void read(const dictionary&);
+        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();
+        //- Do nothing
+        virtual bool execute(const bool postProcess = false);
 
         //- Calculate the regionSizeDistribution and write
-        virtual void write();
-
-        //- Update for changes of mesh
-        virtual void updateMesh(const mapPolyMesh&)
-        {}
-
-        //- Update for changes of mesh
-        virtual void movePoints(const polyMesh&)
-        {}
+        virtual bool write(const bool postProcess = false);
 };
 
 

src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistributionFunctionObject.C

@@ -1,46 +0,0 @@
-/*---------------------------------------------------------------------------*\
-  =========                 |
-  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
-   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2012 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/>.
-
-\*---------------------------------------------------------------------------*/
-
-#include "regionSizeDistributionFunctionObject.H"
-
-// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
-
-namespace Foam
-{
-    defineNamedTemplateTypeNameAndDebug
-    (
-        regionSizeDistributionFunctionObject,
-        0
-    );
-
-    addToRunTimeSelectionTable
-    (
-        functionObject,
-        regionSizeDistributionFunctionObject,
-        dictionary
-    );
-}
-
-// ************************************************************************* //

src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistributionFunctionObject.H

@@ -1,54 +0,0 @@
-/*---------------------------------------------------------------------------*\
-  =========                 |
-  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
-   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2012-2016 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/>.
-
-Typedef
-    Foam::regionSizeDistributionFunctionObject
-
-Description
-    FunctionObject wrapper around regionSizeDistribution to allow it to be
-    created via the functions list within controlDict.
-
-SourceFiles
-    regionSizeDistributionFunctionObject.C
-
-\*---------------------------------------------------------------------------*/
-
-#ifndef regionSizeDistributionFunctionObject_H
-#define regionSizeDistributionFunctionObject_H
-
-#include "regionSizeDistribution.H"
-#include "OutputFilterFunctionObject.H"
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-namespace Foam
-{
-    typedef OutputFilterFunctionObject<functionObjects::regionSizeDistribution>
-        regionSizeDistributionFunctionObject;
-}
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-#endif
-
-// ************************************************************************* //