ENH: Re-located solution/simple/pimple control

src/finiteVolume/cfdTools/general/solutionControl/pimpleControl/pimpleControl.H

@@ -0,0 +1,152 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2011-2011 OpenCFD Ltd.
+     \\/     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::pimpleControl
+
+Description
+    PIMPLE control class to supply convergence information/checks for
+    the PIMPLE loop.
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef pimpleControl_H
+#define pimpleControl_H
+
+#include "solutionControl.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+
+/*---------------------------------------------------------------------------*\
+                        Class pimpleControl Declaration
+\*---------------------------------------------------------------------------*/
+
+class pimpleControl
+:
+    public solutionControl
+{
+protected:
+
+    // Protected data
+
+        // Solution controls
+
+            //- Maximum number of PIMPLE correctors
+            label nOuterCorr_;
+
+            //- Maximum number of PISO correctors
+            label nCorr_;
+
+            //- Current PIMPLE corrector
+            label corr_;
+
+
+    // Protected Member Functions
+
+        //- Read constrols from fvSolution dictionary
+        virtual void read();
+
+        //- Return true if all convergence checks are satified
+        virtual bool criteriaSatisfied();
+
+        //- Disallow default bitwise copy construct
+        pimpleControl(const pimpleControl&);
+
+        //- Disallow default bitwise assignment
+        void operator=(const pimpleControl&);
+
+
+public:
+
+
+    // Static Data Members
+
+        //- Run-time type information
+        TypeName("pimpleControl");
+
+
+    // Constructors
+
+        //- Construct from mesh
+        pimpleControl(fvMesh& mesh);
+
+
+    //- Destructor
+    virtual ~pimpleControl();
+
+
+    // Member Functions
+
+        // Access
+
+            //- Current corrector index
+            inline label corr() const;
+
+            //- Maximum number of PIMPLE correctors
+            inline label nOuterCorr() const;
+
+            //- Maximum number of PISO correctors
+            inline label nCorr() const;
+
+
+        // Solution control
+
+            //- Loop start
+            inline bool start();
+
+            //- Loop loop
+            inline bool loop();
+
+            //- Helper function to identify final PIMPLE (outer) iteration
+            inline bool finalIter() const;
+
+            //- Helper function to identify final inner iteration
+            inline bool finalInnerIter
+            (
+                const label corr,
+                const label nonOrth
+            ) const;
+
+
+    // Member Operators
+
+        void operator++(int);
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#include "pimpleControlI.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //