COMP: Multiple changes - first clean build after latest merge - UNTESTED

src/functionObjects/utilities/runTimeControl/runTimeControl.H

@@ -0,0 +1,141 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2015-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::runTimeControl
+
+Group
+    grpJobControlFunctionObjects
+
+Description
+    Controls when the calculation is terminated based on satisfying
+    user-specified conditions.
+
+    Optionally specify a number of write steps before the calculation is
+    terminated.  Here, a write is performed each time that all conditons are
+    satisfied.
+
+SourceFiles
+    runTimeControl.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef functionObjects_runTimeControl_H
+#define functionObjects_runTimeControl_H
+
+#include "fvMeshFunctionObject.H"
+#include "Map.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+namespace runTimeControls
+{
+
+// Forward declaration of classes
+class runTimeCondition;
+
+/*---------------------------------------------------------------------------*\
+                       Class runTimeControl Declaration
+\*---------------------------------------------------------------------------*/
+
+class runTimeControl
+:
+    public fvMeshFunctionObject
+{
+    // Private data
+
+        //- List of conditions to satisfy
+        PtrList<runTimeCondition> conditions_;
+
+        //- Map to define group IDs
+        Map<label> groupMap_;
+
+        //- Number of write steps before exiting
+        label nWriteStep_;
+
+        //- Current number of steps written
+        label writeStepI_;
+
+
+    // Private Member Functions
+
+        //- Disallow default bitwise copy construct
+        runTimeControl(const runTimeControl&);
+
+        //- Disallow default bitwise assignment
+        void operator=(const runTimeControl&);
+
+
+public:
+
+    //- Runtime type information
+    TypeName("runTimeControl");
+
+
+    // Constructors
+
+        //- Construct for given objectRegistry and dictionary.
+        //  Allow the possibility to load fields from files
+        runTimeControl
+        (
+            const word& name,
+            const Time& runTime,
+            const dictionary& dict
+        );
+
+
+    //- Destructor
+    virtual ~runTimeControl();
+
+
+    // Member Functions
+
+        //- Read the runTimeControl data
+        virtual bool read(const dictionary&);
+
+        //- Execute, currently does nothing
+        virtual bool execute();
+
+        //- Called when time was set at the end of the Time::operator++
+        virtual void timeSet();
+
+        //- Calculate the runTimeControl and write
+        virtual bool write();
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace runTimeControls
+} // End namespace functionObjects
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //