ENH: Refactored stateFunctionObject

- created new functionObjects::properties class derived from IOdictionary
  - replaces raw state IOdictionary owned by functionObjectList
  - state dictionary access/manipulators moved from stateFunctionObject
- stateFunctionObject now acts as a light wrapper around
  functionObjecties::properties
- updated dependent code

src/OpenFOAM/db/functionObjects/functionObjectProperties/functionObjectProperties.C

@@ -0,0 +1,308 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | www.openfoam.com
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+    Copyright (C) 2021 OpenCFD Ltd.
+-------------------------------------------------------------------------------
+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 "functionObjectProperties.H"
+#include "SHA1.H"
+
+// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
+
+const Foam::word Foam::functionObjects::properties::resultsName_ =
+    SHA1("results").str();
+
+
+// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
+
+Foam::functionObjects::properties::properties
+(
+    const IOobject& io
+)
+:
+    IOdictionary(io)
+{}
+
+
+// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
+
+Foam::wordList Foam::functionObjects::properties::objectNames() const
+{
+    // TODO
+    // - remove resultsName_ dict from results?
+    // - or put objects into their own subdictionary?
+    return sortedToc();
+}
+
+
+bool Foam::functionObjects::properties::hasObjectDict
+(
+    const word& objectName
+) const
+{
+    return found(objectName);
+}
+
+
+Foam::dictionary& Foam::functionObjects::properties::getObjectDict
+(
+    const word& objectName
+)
+{
+    if (!found(objectName))
+    {
+        add(objectName, dictionary());
+    }
+
+    return subDict(objectName);
+}
+
+
+bool Foam::functionObjects::properties::setTrigger
+(
+    const label triggeri
+)
+{
+    label oldTriggeri = getOrDefault<label>("triggerIndex", labelMin);
+
+    if (triggeri > oldTriggeri)
+    {
+        set("triggerIndex", triggeri);
+        return true;
+    }
+
+    return false;
+}
+
+
+Foam::label Foam::functionObjects::properties::getTrigger() const
+{
+    return getOrDefault<label>("triggerIndex", labelMin);
+}
+
+
+bool Foam::functionObjects::properties::foundObjectProperty
+(
+    const word& objectName,
+    const word& entryName
+) const
+{
+    if (found(objectName))
+    {
+        const dictionary& baseDict = subDict(objectName);
+        return baseDict.found(entryName);
+    }
+
+    return false;
+}
+
+
+bool Foam::functionObjects::properties::getObjectDict
+(
+    const word& objectName,
+    const word& entryName,
+    dictionary& dict
+) const
+{
+    if (found(objectName))
+    {
+        const dictionary& baseDict = subDict(objectName);
+
+        if (baseDict.found(entryName) && baseDict.isDict(entryName))
+        {
+            dict = baseDict.subDict(entryName);
+            return true;
+        }
+    }
+
+    return false;
+}
+
+
+bool Foam::functionObjects::properties::hasResultObject
+(
+    const word& objectName
+) const
+{
+    if (found(resultsName_))
+    {
+        return subDict(resultsName_).found(objectName);
+    }
+
+    return false;
+}
+
+
+Foam::wordList Foam::functionObjects::properties::objectResultNames() const
+{
+    if (found(resultsName_))
+    {
+        return subDict(resultsName_).sortedToc();
+    }
+
+    return wordList();
+}
+
+
+bool Foam::functionObjects::properties::hasResultObjectEntry
+(
+    const word& objectName,
+    const word& entryName
+) const
+{
+    if (found(resultsName_))
+    {
+        const dictionary& resultsDict = subDict(resultsName_);
+
+        if (resultsDict.found(objectName))
+        {
+            const dictionary& objectDict = resultsDict.subDict(objectName);
+
+            for (const entry& dEntry : objectDict)
+            {
+                const dictionary& dict = dEntry.dict();
+
+                if (dict.found(entryName))
+                {
+                    return true;
+                }
+            }
+        }
+    }
+
+    return false;
+}
+
+
+Foam::word Foam::functionObjects::properties::objectResultType
+(
+    const word& objectName,
+    const word& entryName
+) const
+{
+    if (found(resultsName_))
+    {
+        const dictionary& resultsDict = subDict(resultsName_);
+
+        if (resultsDict.found(objectName))
+        {
+            const dictionary& objectDict = resultsDict.subDict(objectName);
+
+            for (const entry& dEntry : objectDict)
+            {
+                const dictionary& dict = dEntry.dict();
+
+                if (dict.found(entryName))
+                {
+                    return dict.dictName();
+                }
+            }
+        }
+    }
+
+    return word::null;
+}
+
+
+Foam::wordList Foam::functionObjects::properties::objectResultEntries
+(
+    const word& objectName
+) const
+{
+    DynamicList<word> result;
+
+    if (found(resultsName_))
+    {
+        const dictionary& resultsDict = subDict(resultsName_);
+
+        if (resultsDict.found(objectName))
+        {
+            const dictionary& objectDict = resultsDict.subDict(objectName);
+
+            for (const entry& dEntry : objectDict)
+            {
+                const dictionary& dict = dEntry.dict();
+
+                result.append(dict.toc());
+            }
+        }
+    }
+
+    wordList entries;
+    entries.transfer(result);
+
+    return entries;
+}
+
+
+void Foam::functionObjects::properties::writeResultEntries
+(
+    const word& objectName,
+    Ostream& os
+) const
+{
+    if (found(resultsName_))
+    {
+        const dictionary& resultsDict = subDict(resultsName_);
+
+        if (resultsDict.found(objectName))
+        {
+            const dictionary& objectDict = resultsDict.subDict(objectName);
+
+            for (const word& dataFormat : objectDict.sortedToc())
+            {
+                os  << "    Type: " << dataFormat << nl;
+
+                const dictionary& resultDict = objectDict.subDict(dataFormat);
+
+                for (const word& result : resultDict.sortedToc())
+                {
+                    os << "        " << result << nl;
+                }
+            }
+        }
+    }
+}
+
+
+void Foam::functionObjects::properties::writeAllResultEntries
+(
+    Ostream& os
+) const
+{
+    if (found(resultsName_))
+    {
+        const dictionary& resultsDict = subDict(resultsName_);
+
+        for (const word& objectName : resultsDict.sortedToc())
+        {
+            os  << "Object: " << objectName << endl;
+
+            writeResultEntries(objectName, os);
+        }
+    }
+}
+
+
+// ************************************************************************* //