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

@@ -30,6 +30,7 @@ License
 #include "turbulentTransportModel.H"
 #include "turbulentFluidThermoModel.H"
 #include "surfaceInterpolate.H"
+#include "addToRunTimeSelectionTable.H"
 
 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
@@ -38,6 +39,13 @@ namespace Foam
 namespace functionObjects
 {
     defineTypeNameAndDebug(Peclet, 0);
+
+    addToRunTimeSelectionTable
+    (
+        functionObject,
+        Peclet,
+        dictionary
+    );
 }
 }
 
@@ -47,17 +55,22 @@ namespace functionObjects
 Foam::functionObjects::Peclet::Peclet
 (
     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)
+        )
+    ),
     phiName_("phi"),
     rhoName_("rho")
 {
-    if (!isA<fvMesh>(obr))
+    if (!isA<fvMesh>(obr_))
     {
         FatalErrorInFunction
             << "objectRegistry is not an fvMesh" << exit(FatalError);
@@ -96,14 +109,16 @@ Foam::functionObjects::Peclet::~Peclet()
 
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
-void Foam::functionObjects::Peclet::read(const dictionary& dict)
+bool Foam::functionObjects::Peclet::read(const dictionary& dict)
 {
     phiName_ = dict.lookupOrDefault<word>("phiName", "phi");
     rhoName_ = dict.lookupOrDefault<word>("rhoName", "rho");
+
+    return true;
 }
 
 
-void Foam::functionObjects::Peclet::execute()
+bool Foam::functionObjects::Peclet::execute(const bool postProcess)
 {
     typedef compressible::turbulenceModel cmpTurbModel;
     typedef incompressible::turbulenceModel icoTurbModel;
@@ -183,28 +198,23 @@ void Foam::functionObjects::Peclet::execute()
            *mesh.surfaceInterpolation::deltaCoeffs()
            *fvc::interpolate(nuEff)
         );
+
+    return true;
 }
 
 
-void Foam::functionObjects::Peclet::end()
-{
-    execute();
-}
-
-void Foam::functionObjects::Peclet::timeSet()
-{}
-
-
-void Foam::functionObjects::Peclet::write()
+bool Foam::functionObjects::Peclet::write(const bool postProcess)
 {
     const surfaceScalarField& Peclet =
         obr_.lookupObject<surfaceScalarField>(type());
 
-    Info<< type() << " " << name_ << " output:" << nl
+    Info<< type() << " " << name() << " output:" << nl
         << "    writing field " << Peclet.name() << nl
         << endl;
 
     Peclet.write();
+
+    return true;
 }