regionFunctionObject: Moved the field/object maintenance functions from fvMeshFunctionObject into regionFunctionObject

src/OpenFOAM/db/functionObjects/regionFunctionObject/regionFunctionObject.C

@@ -38,6 +38,59 @@ namespace functionObjects
 }
 
 
+// * * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * //
+
+bool Foam::functionObjects::regionFunctionObject::writeObject
+(
+    const word& fieldName
+)
+{
+    if (obr_.foundObject<regIOobject>(fieldName))
+    {
+        const regIOobject& field = obr_.lookupObject<regIOobject>(fieldName);
+
+        if (log_)
+        {
+            Info<< "functionObjects::" << type() << " " << name()
+                << " writing field: " << field.name() << endl;
+        }
+
+        field.write();
+
+        return true;
+    }
+    else
+    {
+        return false;
+    }
+}
+
+
+bool Foam::functionObjects::regionFunctionObject::clearObject
+(
+    const word& fieldName
+)
+{
+    if (foundObject<regIOobject>(fieldName))
+    {
+        const regIOobject& resultObject = lookupObject<regIOobject>(fieldName);
+
+        if (resultObject.ownedByRegistry())
+        {
+            return const_cast<regIOobject&>(resultObject).checkOut();
+        }
+        else
+        {
+            return false;
+        }
+    }
+    else
+    {
+        return true;
+    }
+}
+
+
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
 Foam::functionObjects::regionFunctionObject::regionFunctionObject

src/OpenFOAM/db/functionObjects/regionFunctionObject/regionFunctionObject.H

@@ -76,6 +76,32 @@ protected:
         Switch log_;
 
 
+    // Protected member functions
+
+        //- Find field in the objectRegistry
+        template<class ObjectType>
+        bool foundObject(const word& fieldName) const;
+
+        //- Lookup field from the objectRegistry
+        template<class ObjectType>
+        const ObjectType& lookupObject(const word& fieldName) const;
+
+        //- Store the given field in the objectRegistry under the given name
+        template<class ObjectType>
+        bool store
+        (
+            word& fieldName,
+            const tmp<ObjectType>& tfield,
+            bool cacheable = false
+        );
+
+        //- Write field if present in objectRegistry
+        bool writeObject(const word& fieldName);
+
+        //- Clear field from the objectRegistry if present
+        bool clearObject(const word& fieldName);
+
+
 private:
 
     // Private Member Functions
@@ -132,6 +158,12 @@ public:
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
+#ifdef NoRepository
+    #include "regionFunctionObjectTemplates.C"
+#endif
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
 #endif
 
 // ************************************************************************* //

src/OpenFOAM/db/functionObjects/regionFunctionObject/regionFunctionObjectTemplates.C

@@ -0,0 +1,112 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 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 "regionFunctionObject.H"
+#include "objectRegistry.H"
+
+// * * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * //
+
+template<class ObjectType>
+bool Foam::functionObjects::regionFunctionObject::foundObject
+(
+    const word& fieldName
+) const
+{
+    return obr_.foundObject<ObjectType>(fieldName);
+}
+
+
+template<class ObjectType>
+const ObjectType& Foam::functionObjects::regionFunctionObject::lookupObject
+(
+    const word& fieldName
+) const
+{
+    return obr_.lookupObject<ObjectType>(fieldName);
+}
+
+
+template<class ObjectType>
+bool Foam::functionObjects::regionFunctionObject::store
+(
+    word& fieldName,
+    const tmp<ObjectType>& tfield,
+    bool cacheable
+)
+{
+    if (cacheable && fieldName == tfield().name())
+    {
+        WarningInFunction
+            << "Cannot store cache-able field with the named used in the cache."
+            << nl
+            << "    Either choose a different name or cache the field"
+            << "    and use the 'writeRegisteredObject' functionObject."
+            << endl;
+
+        return false;
+    }
+
+    if
+    (
+        fieldName.size()
+     && obr_.foundObject<ObjectType>(fieldName)
+    )
+    {
+        const ObjectType& field =
+        (
+            obr_.lookupObject<ObjectType>(fieldName)
+        );
+
+        // If there is a result field already registered assign to the new
+        // result field otherwise transfer ownership of the new result field to
+        // the object registry
+        if (&field != &tfield())
+        {
+            const_cast<ObjectType&>(field) = tfield;
+        }
+        else
+        {
+            obr_.objectRegistry::store(tfield.ptr());
+        }
+    }
+    else
+    {
+        if (fieldName.size() && fieldName != tfield().name())
+        {
+            tfield.ref().rename(fieldName);
+        }
+        else
+        {
+            fieldName = tfield().name();
+        }
+
+        obr_.objectRegistry::store(tfield.ptr());
+    }
+
+    return true;
+}
+
+
+// ************************************************************************* //