ENH: Added simpleControl class

src/finiteVolume/Make/files

@@ -352,6 +352,8 @@ general = cfdTools/general
 $(general)/findRefCell/findRefCell.C
 $(general)/adjustPhi/adjustPhi.C
 $(general)/bound/bound.C
+$(general)/solutionControl/solutionControl.C
+$(general)/simpleControl/simpleControl.C
 $(general)/pimpleControl/pimpleControl.C
 
 porousMedia = $(general)/porousMedia

src/finiteVolume/cfdTools/general/simpleControl/simpleControl.C

+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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/>.
+
+\*---------------------------------------------------------------------------*/
+
+#include "simpleControl.H"
+#include "Time.H"
+
+// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
+
+namespace Foam
+{
+    defineTypeNameAndDebug(simpleControl, 0);
+}
+
+
+// * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * * //
+
+void Foam::simpleControl::read()
+{
+    solutionControl::read(true);
+}
+
+
+bool Foam::simpleControl::criteriaSatisfied()
+{
+    if (residualControl_.empty())
+    {
+        return false;
+    }
+
+    bool achieved = true;
+    const dictionary& solverDict = mesh_.solverPerformanceDict();
+
+    forAllConstIter(dictionary, solverDict, iter)
+    {
+        const word& variableName = iter().keyword();
+        label fieldI = applyToField(variableName);
+        if (fieldI != -1)
+        {
+            const List<lduMatrix::solverPerformance> sp(iter().stream());
+            const scalar residual = sp.first().initialResidual();
+
+            bool absCheck = residual < residualControl_[fieldI].absTol;
+            achieved = achieved && absCheck;
+
+            if (debug)
+            {
+                Info<< dictName_ << " solution statistics:" << endl;
+
+                Info<< "    " << variableName << ": abs tol = " << residual
+                    << " (" << residualControl_[fieldI].absTol << ")"
+                    << endl;
+            }
+        }
+    }
+
+    return achieved;
+}
+
+
+// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
+
+Foam::simpleControl::simpleControl(fvMesh& mesh)
+:
+    solutionControl(mesh, "SIMPLE"),
+    initialised_(false)
+{
+    read();
+
+    if (residualControl_.size() > 0)
+    {
+        Info<< dictName_ << " convergence criteria" << endl;
+        forAll(residualControl_, i)
+        {
+            Info<< "    field " << residualControl_[i].name << token::TAB
+                << " absTol " << residualControl_[i].absTol
+                << nl;
+        }
+        Info<< endl;
+    }
+    else
+    {
+        Info<< "No " << dictName_ << " convergence criteria found. "
+            << "Calculations will run for " << mesh_.time().endTime().value()
+            << " steps." << nl << endl;
+    }
+}
+
+
+// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
+
+Foam::simpleControl::~simpleControl()
+{}
+
+
+// ************************************************************************* //

src/finiteVolume/cfdTools/general/simpleControl/simpleControl.H

+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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::simpleControl
+
+Description
+    SIMPLE control class to supply convergence information/checks for
+    the SIMPLE loop.
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef simpleControl_H
+#define simpleControl_H
+
+#include "solutionControl.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+
+/*---------------------------------------------------------------------------*\
+                         Class simpleControl Declaration
+\*---------------------------------------------------------------------------*/
+
+class simpleControl
+:
+    public solutionControl
+{
+
+protected:
+
+    // Protected Data
+
+        //- Initialised flag
+        bool initialised_;
+
+
+    // Protected Member Functions
+
+        //- Read constrols from fvSolution dictionary
+        void read();
+
+        //- Return true if all convergence checks are satified
+        bool criteriaSatisfied();
+
+        //- Disallow default bitwise copy construct
+        simpleControl(const simpleControl&);
+
+        //- Disallow default bitwise assignment
+        void operator=(const simpleControl&);
+
+
+public:
+
+
+    // Static Data Members
+
+        //- Run-time type information
+        TypeName("simpleControl");
+
+
+    // Constructors
+
+        //- Construct from mesh
+        simpleControl(fvMesh& mesh);
+
+
+    //- Destructor
+    virtual ~simpleControl();
+
+
+    // Member Functions
+
+        // Solution control
+
+            //- Loop loop
+            inline bool loop();
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#include "simpleControlI.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //

src/finiteVolume/cfdTools/general/simpleControl/simpleControlI.H

+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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/>.
+
+\*---------------------------------------------------------------------------*/
+
+#include "Time.H"
+
+// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
+
+inline bool Foam::simpleControl::loop()
+{
+    read();
+
+    Time& time = const_cast<Time&>(mesh_.time());
+
+    if (initialised_)
+    {
+        if (criteriaSatisfied())
+        {
+            Info<< dictName_ << " solution converged in " << time.timeName()
+                << " iterations" << nl << endl;
+
+            // Set to finalise calculation
+            time.writeAndEnd();
+        }
+    }
+    else
+    {
+        initialised_ = true;
+    }
+
+    return time.loop();
+}
+
+
+// ************************************************************************* //