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/utilities/vorticity/vorticity.C

@@ -25,8 +25,8 @@ License
 
 #include "vorticity.H"
 #include "volFields.H"
-#include "dictionary.H"
 #include "fvcCurl.H"
+#include "addToRunTimeSelectionTable.H"
 
 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
@@ -35,6 +35,13 @@ namespace Foam
 namespace functionObjects
 {
     defineTypeNameAndDebug(vorticity, 0);
+
+    addToRunTimeSelectionTable
+    (
+        functionObject,
+        vorticity,
+        dictionary
+    );
 }
 }
 
@@ -44,17 +51,22 @@ namespace functionObjects
 Foam::functionObjects::vorticity::vorticity
 (
     const word& name,
-    const objectRegistry& obr,
-    const dictionary& dict,
-    const bool loadFromFiles
+    const Time& runTime,
+    const dictionary& dict
 )
 :
-    name_(name),
-    obr_(obr),
+    functionObject(name),
+    obr_
+    (
+        runTime.lookupObject<objectRegistry>
+        (
+            dict.lookupOrDefault("region", polyMesh::defaultRegion)
+        )
+    ),
     UName_("U"),
     outputName_(typeName)
 {
-    if (!isA<fvMesh>(obr))
+    if (!isA<fvMesh>(obr_))
     {
         FatalErrorInFunction
             << "objectRegistry is not an fvMesh" << exit(FatalError);
@@ -93,17 +105,19 @@ Foam::functionObjects::vorticity::~vorticity()
 
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
-void Foam::functionObjects::vorticity::read(const dictionary& dict)
+bool Foam::functionObjects::vorticity::read(const dictionary& dict)
 {
     UName_ = dict.lookupOrDefault<word>("UName", "U");
     if (UName_ != "U")
     {
         outputName_ = typeName + "(" + UName_ + ")";
     }
+
+    return true;
 }
 
 
-void Foam::functionObjects::vorticity::execute()
+bool Foam::functionObjects::vorticity::execute(const bool postProcess)
 {
     const volVectorField& U = obr_.lookupObject<volVectorField>(UName_);
 
@@ -113,29 +127,23 @@ void Foam::functionObjects::vorticity::execute()
     );
 
     vorticity = fvc::curl(U);
+
+    return true;
 }
 
 
-void Foam::functionObjects::vorticity::end()
-{
-    execute();
-}
-
-
-void Foam::functionObjects::vorticity::timeSet()
-{}
-
-
-void Foam::functionObjects::vorticity::write()
+bool Foam::functionObjects::vorticity::write(const bool postProcess)
 {
     const volVectorField& vorticity =
         obr_.lookupObject<volVectorField>(outputName_);
 
-    Info<< type() << " " << name_ << " output:" << nl
+    Info<< type() << " " << name() << " output:" << nl
         << "    writing field " << vorticity.name() << nl
         << endl;
 
     vorticity.write();
+
+    return true;
 }
 
 

src/postProcessing/functionObjects/utilities/vorticity/vorticity.H

@@ -38,6 +38,7 @@ SourceFiles
 #ifndef functionObjects_vorticity_H
 #define functionObjects_vorticity_H
 
+#include "functionObject.H"
 #include "volFieldsFwd.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
@@ -47,9 +48,6 @@ namespace Foam
 
 // Forward declaration of classes
 class objectRegistry;
-class dictionary;
-class polyMesh;
-class mapPolyMesh;
 
 namespace functionObjects
 {
@@ -59,12 +57,11 @@ namespace functionObjects
 \*---------------------------------------------------------------------------*/
 
 class vorticity
+:
+    public functionObject
 {
     // Private data
 
-        //- Name of this set of vorticity objects
-        word name_;
-
         //- Reference to the database
         const objectRegistry& obr_;
 
@@ -92,14 +89,12 @@ public:
 
     // Constructors
 
-        //- Construct for given objectRegistry and dictionary.
-        //  Allow the possibility to load fields from files
+        //- Construct from Time and dictionary
         vorticity
         (
             const word& name,
-            const objectRegistry&,
-            const dictionary&,
-            const bool loadFromFiles = false
+            const Time& runTime,
+            const dictionary& dict
         );
 
 
@@ -109,34 +104,14 @@ public:
 
     // Member Functions
 
-        //- Return name of the set of vorticity
-        virtual const word& name() const
-        {
-            return name_;
-        }
-
         //- Read the vorticity 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();
+        virtual bool execute(const bool postProcess = false);
 
         //- Calculate the vorticity 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/utilities/vorticity/vorticityFunctionObject.C

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

src/postProcessing/functionObjects/utilities/vorticity/vorticityFunctionObject.H

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