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/OpenFOAM/db/functionObjects/writeFiles/writeFiles.C

@@ -0,0 +1,203 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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/>.
+
+\*---------------------------------------------------------------------------*/
+
+#include "writeFiles.H"
+#include "Time.H"
+#include "IFstream.H"
+
+// * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * * //
+
+void Foam::functionObjects::writeFiles::createFiles()
+{
+    if (Pstream::master())
+    {
+        const word startTimeName =
+            obr_.time().timeName(obr_.time().startTime().value());
+
+        forAll(names_, i)
+        {
+            if (!filePtrs_.set(i))
+            {
+                fileName outputDir(baseFileDir()/prefix_/startTimeName);
+                mkDir(outputDir);
+
+                word fName(names_[i]);
+
+                // Check if file already exists
+                IFstream is(outputDir/(fName + ".dat"));
+                if (is.good())
+                {
+                    fName = fName + "_" + obr_.time().timeName();
+                }
+
+                filePtrs_.set(i, new OFstream(outputDir/(fName + ".dat")));
+
+                initStream(filePtrs_[i]);
+
+                writeFileHeader(i);
+
+            }
+        }
+    }
+}
+
+
+void Foam::functionObjects::writeFiles::write()
+{
+    createFiles();
+}
+
+
+void Foam::functionObjects::writeFiles::resetNames(const wordList& names)
+{
+    names_.clear();
+    names_.append(names);
+
+    if (Pstream::master())
+    {
+        filePtrs_.clear();
+        filePtrs_.setSize(names_.size());
+    }
+}
+
+
+void Foam::functionObjects::writeFiles::resetName(const word& name)
+{
+    names_.clear();
+    names_.append(name);
+
+    if (Pstream::master())
+    {
+        filePtrs_.clear();
+        filePtrs_.setSize(1);
+    }
+}
+
+
+// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
+
+Foam::functionObjects::writeFiles::writeFiles
+(
+    const word& name,
+    const Time& time,
+    const dictionary& dict,
+    const word& prefix
+)
+:
+    writeFile(name, time, dict, prefix),
+    names_(),
+    filePtrs_()
+{}
+
+
+Foam::functionObjects::writeFiles::writeFiles
+(
+    const word& name,
+    const objectRegistry& obr,
+    const dictionary& dict,
+    const word& prefix
+)
+:
+    writeFile(name, obr, dict, prefix),
+    names_(),
+    filePtrs_()
+{}
+
+
+// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
+
+Foam::functionObjects::writeFiles::~writeFiles()
+{}
+
+
+// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
+
+const Foam::wordList& Foam::functionObjects::writeFiles::names() const
+{
+    return names_;
+}
+
+
+Foam::OFstream& Foam::functionObjects::writeFiles::file()
+{
+    if (!Pstream::master())
+    {
+        FatalErrorInFunction
+            << "Request for file() can only be done by the master process"
+            << abort(FatalError);
+    }
+
+    if (filePtrs_.size() != 1)
+    {
+        WarningInFunction
+            << "Requested single file, but multiple files are present"
+            << endl;
+    }
+
+    if (!filePtrs_.set(0))
+    {
+        FatalErrorInFunction
+            << "File pointer at index " << 0 << " not allocated"
+            << abort(FatalError);
+    }
+
+    return filePtrs_[0];
+}
+
+
+Foam::PtrList<Foam::OFstream>& Foam::functionObjects::writeFiles::files()
+{
+    if (!Pstream::master())
+    {
+        FatalErrorInFunction
+            << "Request for files() can only be done by the master process"
+            << abort(FatalError);
+    }
+
+    return filePtrs_;
+}
+
+
+Foam::OFstream& Foam::functionObjects::writeFiles::file(const label i)
+{
+    if (!Pstream::master())
+    {
+        FatalErrorInFunction
+            << "Request for file(i) can only be done by the master process"
+            << abort(FatalError);
+    }
+
+    if (!filePtrs_.set(i))
+    {
+        FatalErrorInFunction
+            << "File pointer at index " << i << " not allocated"
+            << abort(FatalError);
+    }
+
+    return filePtrs_[i];
+}
+
+
+// ************************************************************************* //