functionObjects: Added regionFunctionObject and fvMeshFunctionObject intermediate base-classes

to simplify writing common functionObjects and avoid unnecessary code duplication

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

@@ -0,0 +1,127 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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/>.
+
+Class
+    Foam::functionObjects::regionFunctionObject
+
+Description
+    Specialization of Foam::functionObject for a region and providing a
+    reference to the region Foam::objectRegistry.
+
+SeeAlso
+    Foam::functionObject
+
+SourceFiles
+    regionFunctionObject.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef functionObjects_regionFunctionObject_H
+#define functionObjects_regionFunctionObject_H
+
+#include "functionObject.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+
+// Forward declaration of classes
+class objectRegistry;
+
+namespace functionObjects
+{
+
+/*---------------------------------------------------------------------------*\
+                     Class regionFunctionObject Declaration
+\*---------------------------------------------------------------------------*/
+
+class regionFunctionObject
+:
+    public functionObject
+{
+
+protected:
+
+    // Protected member data
+
+        //- Reference to the Time
+        const Time& time_;
+
+        //- Reference to the region objectRegistry
+        const objectRegistry& obr_;
+
+
+private:
+
+    // Private Member Functions
+
+        //- Disallow default bitwise copy construct
+        regionFunctionObject(const regionFunctionObject&);
+
+        //- Disallow default bitwise assignment
+        void operator=(const regionFunctionObject&);
+
+
+public:
+
+    //- Runtime type information
+    TypeName("regionFunctionObject");
+
+
+    // Constructors
+
+        //- Construct from Time and dictionary.
+        //  The region objectRegistry is looked-up runTime with the name
+        //  looked-up from the dictionary (defaults to polyMesh::defaultRegion)
+        regionFunctionObject
+        (
+            const word& name,
+            const Time& runTime,
+            const dictionary& dict
+        );
+
+        //- Construct from the region objectRegistry and dictionary
+        regionFunctionObject
+        (
+            const word& name,
+            const objectRegistry& obr,
+            const dictionary& dict
+        );
+
+
+    //- Destructor
+    virtual ~regionFunctionObject();
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace functionObjects
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //