convergence check for terminating SIMPLE steady-state solvers

- rhoPorousSimpleFoam
  - rhoSimpleFoam
  - buoyantSimpleFoam
  - buoyantSimpleRadiationFoam
  - simpleFoam

applications/solvers/compressible/rhoPorousSimpleFoam/UEqn.H

@@ -35,7 +35,12 @@
     {
         pZones.addResistance(UEqn());
 
-        solve(UEqn() == -fvc::grad(p));
+        eqnResidual = solve
+        (
+            UEqn() == -fvc::grad(p)
+        ). initialResidual();
+
+        maxResidual = max(eqnResidual, maxResidual);
 
         trAU = 1.0/UEqn().A();
         trAU().rename("rAU");

applications/solvers/compressible/rhoPorousSimpleFoam/convergenceCheck.H

@@ -0,0 +1,9 @@
+// check convergence
+
+if (maxResidual < convergenceCriterion)
+{
+    Info<< "reached convergence criterion: " << convergenceCriterion << endl;
+    runTime.writeAndEnd();
+    Info<< "latestTime = " << runTime.timeName() << endl;
+}
+

applications/solvers/compressible/rhoPorousSimpleFoam/hEqn.H

@@ -11,7 +11,8 @@
 
     hEqn.relax();
 
-    hEqn.solve();
+    eqnResidual = hEqn.solve().initialResidual();
+    maxResidual = max(eqnResidual, maxResidual);
 
     thermo->correct();
 }

applications/solvers/compressible/rhoPorousSimpleFoam/initConvergenceCheck.H

@@ -0,0 +1,7 @@
+// initialize values for convergence checks
+
+    scalar eqnResidual = 1, maxResidual = 0;
+    scalar convergenceCriterion = 0;
+
+    simple.readIfPresent("convergence", convergenceCriterion);
+

applications/solvers/compressible/rhoPorousSimpleFoam/pEqn.H

@@ -26,7 +26,16 @@ for (int nonOrth=0; nonOrth<=nNonOrthCorr; nonOrth++)
     }
 
     tpEqn().setReference(pRefCell, pRefValue);
-    tpEqn().solve();
+    // retain the residual from the first iteration
+    if (nonOrth == 0)
+    {
+        eqnResidual = tpEqn().solve().initialResidual();
+        maxResidual = max(eqnResidual, maxResidual);
+    }
+    else
+    {
+        tpEqn().solve();
+    }
 
     if (nonOrth == nNonOrthCorr)
     {

applications/solvers/compressible/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C

@@ -56,6 +56,7 @@ int main(int argc, char *argv[])
         Info<< "Time = " << runTime.timeName() << nl << endl;
 
 #       include "readSIMPLEControls.H"
+#       include "initConvergenceCheck.H"
 
         p.storePrevIter();
         rho.storePrevIter();
@@ -70,10 +71,11 @@ int main(int argc, char *argv[])
         turbulence->correct();
 
         runTime.write();
-
         Info<< "ExecutionTime = " << runTime.elapsedCpuTime() << " s"
             << "  ClockTime = " << runTime.elapsedClockTime() << " s"
             << nl << endl;
+
+#       include "convergenceCheck.H"
     }
 
     Info<< "End\n" << endl;

applications/solvers/compressible/rhoSimpleFoam/UEqn.H

@@ -9,4 +9,9 @@
 
     UEqn().relax();
 
-    solve(UEqn() == -fvc::grad(p));
+    eqnResidual = solve
+    (
+        UEqn() == -fvc::grad(p)
+    ).initialResidual();
+
+    maxResidual = max(eqnResidual, maxResidual);

applications/solvers/compressible/rhoSimpleFoam/convergenceCheck.H

@@ -0,0 +1,9 @@
+// check convergence
+
+if (maxResidual < convergenceCriterion)
+{
+    Info<< "reached convergence criterion: " << convergenceCriterion << endl;
+    runTime.writeAndEnd();
+    Info<< "latestTime = " << runTime.timeName() << endl;
+}
+

applications/solvers/compressible/rhoSimpleFoam/hEqn.H

@@ -11,7 +11,8 @@
 
     hEqn.relax();
 
-    hEqn.solve();
+    eqnResidual = hEqn.solve().initialResidual();
+    maxResidual = max(eqnResidual, maxResidual);
 
     thermo->correct();
 }

applications/solvers/compressible/rhoSimpleFoam/initConvergenceCheck.H

@@ -0,0 +1,7 @@
+// initialize values for convergence checks
+
+    scalar eqnResidual = 1, maxResidual = 0;
+    scalar convergenceCriterion = 0;
+
+    simple.readIfPresent("convergence", convergenceCriterion);
+

applications/solvers/compressible/rhoSimpleFoam/pEqn.H

@@ -12,7 +12,16 @@ for (int nonOrth=0; nonOrth<=nNonOrthCorr; nonOrth++)
     );
 
     pEqn.setReference(pRefCell, pRefValue);
-    pEqn.solve();
+    // retain the residual from the first iteration
+    if (nonOrth == 0)
+    {
+        eqnResidual = pEqn.solve().initialResidual();
+        maxResidual = max(eqnResidual, maxResidual);
+    }
+    else
+    {
+        pEqn.solve();
+    }
 
     if (nonOrth == nNonOrthCorr)
     {

applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C

@@ -26,8 +26,7 @@ Application
     rhoSimpleFoam
 
 Description
-    Steady-state solver for turbulent flow of compressible fluids for
+    Steady-state solver for turbulent flow of compressible fluids
-    ventilation and heat-transfer.
 
 \*---------------------------------------------------------------------------*/
 
@@ -56,6 +55,7 @@ int main(int argc, char *argv[])
         Info<< "Time = " << runTime.timeName() << nl << endl;
 
 #       include "readSIMPLEControls.H"
+#       include "initConvergenceCheck.H"
 
         p.storePrevIter();
         rho.storePrevIter();
@@ -74,6 +74,8 @@ int main(int argc, char *argv[])
         Info<< "ExecutionTime = " << runTime.elapsedCpuTime() << " s"
             << "  ClockTime = " << runTime.elapsedClockTime() << " s"
             << nl << endl;
+
+#       include "convergenceCheck.H"
     }
 
     Info<< "End\n" << endl;

applications/solvers/heatTransfer/buoyantSimpleFoam/UEqn.H

@@ -9,4 +9,10 @@
 
     UEqn().relax();
 
-    solve(UEqn() == -fvc::grad(pd) - fvc::grad(rho)*gh);
+    eqnResidual = solve
+    (
+        UEqn() == -fvc::grad(pd) - fvc::grad(rho)*gh
+    ).initialResidual();
+
+    maxResidual = max(eqnResidual, maxResidual);
+

applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C

@@ -26,8 +26,7 @@ Application
     buoyantSimpleFoam
 
 Description
-    Steady-state solver for buoyant, turbulent flow of compressible fluids for
+    Steady-state solver for buoyant, turbulent flow of compressible fluids
-    ventilation and heat-transfer.
 
 \*---------------------------------------------------------------------------*/
 
@@ -57,6 +56,7 @@ int main(int argc, char *argv[])
         Info<< "Time = " << runTime.timeName() << nl << endl;
 
 #       include "readSIMPLEControls.H"
+#       include "initConvergenceCheck.H"
 
         pd.storePrevIter();
         rho.storePrevIter();
@@ -64,9 +64,7 @@ int main(int argc, char *argv[])
         // Pressure-velocity SIMPLE corrector
         {
 #           include "UEqn.H"
-
 #           include "hEqn.H"
-
 #           include "pEqn.H"
         }
 
@@ -77,6 +75,8 @@ int main(int argc, char *argv[])
         Info<< "ExecutionTime = " << runTime.elapsedCpuTime() << " s"
             << "  ClockTime = " << runTime.elapsedClockTime() << " s"
             << nl << endl;
+
+#       include "convergenceCheck.H"
     }
 
     Info<< "End\n" << endl;

applications/solvers/heatTransfer/buoyantSimpleFoam/convergenceCheck.H

@@ -0,0 +1,9 @@
+// check convergence
+
+if (maxResidual < convergenceCriterion)
+{
+    Info<< "reached convergence criterion: " << convergenceCriterion << endl;
+    runTime.writeAndEnd();
+    Info<< "latestTime = " << runTime.timeName() << endl;
+}
+

applications/solvers/heatTransfer/buoyantSimpleFoam/hEqn.H

@@ -11,7 +11,8 @@
 
     hEqn.relax();
 
-    hEqn.solve();
+    eqnResidual = hEqn.solve().initialResidual();
+    maxResidual = max(eqnResidual, maxResidual);
 
     thermo->correct();
 }

applications/solvers/heatTransfer/buoyantSimpleFoam/initConvergenceCheck.H

@@ -0,0 +1,7 @@
+// initialize values for convergence checks
+
+    scalar eqnResidual = 1, maxResidual = 0;
+    scalar convergenceCriterion = 0;
+
+    simple.readIfPresent("convergence", convergenceCriterion);
+

applications/solvers/heatTransfer/buoyantSimpleFoam/pEqn.H

@@ -13,7 +13,16 @@ for (int nonOrth=0; nonOrth<=nNonOrthCorr; nonOrth++)
     );
 
     pdEqn.setReference(pdRefCell, pdRefValue);
-    pdEqn.solve();
+    // retain the residual from the first iteration
+    if (nonOrth == 0)
+    {
+        eqnResidual = pdEqn.solve().initialResidual();
+        maxResidual = max(eqnResidual, maxResidual);
+    }
+    else
+    {
+        pdEqn.solve();
+    }
 
     if (nonOrth == nNonOrthCorr)
     {

applications/solvers/heatTransfer/buoyantSimpleRadiationFoam/UEqn.H

@@ -9,4 +9,10 @@
 
     UEqn().relax();
 
-    solve(UEqn() == -fvc::grad(pd) - fvc::grad(rho)*gh);
+    eqnResidual = solve
+    (
+        UEqn() == -fvc::grad(pd) - fvc::grad(rho)*gh
+    ).initialResidual();
+
+    maxResidual = max(eqnResidual, maxResidual);
+

applications/solvers/heatTransfer/buoyantSimpleRadiationFoam/buoyantSimpleRadiationFoam.C

@@ -58,6 +58,7 @@ int main(int argc, char *argv[])
         Info<< "Time = " << runTime.timeName() << nl << endl;
 
 #       include "readSIMPLEControls.H"
+#       include "initConvergenceCheck.H"
 
         pd.storePrevIter();
         rho.storePrevIter();
@@ -65,9 +66,7 @@ int main(int argc, char *argv[])
         // Pressure-velocity SIMPLE corrector
         {
 #           include "UEqn.H"
-
 #           include "hEqn.H"
-
 #           include "pEqn.H"
         }
 
@@ -78,6 +77,8 @@ int main(int argc, char *argv[])
         Info<< "ExecutionTime = " << runTime.elapsedCpuTime() << " s"
             << "  ClockTime = " << runTime.elapsedClockTime() << " s"
             << nl << endl;
+
+#       include "convergenceCheck.H"
     }
 
     Info<< "End\n" << endl;

applications/solvers/heatTransfer/buoyantSimpleRadiationFoam/convergenceCheck.H

@@ -0,0 +1,9 @@
+// check convergence
+
+if (maxResidual < convergenceCriterion)
+{
+    Info<< "reached convergence criterion: " << convergenceCriterion << endl;
+    runTime.writeAndEnd();
+    Info<< "latestTime = " << runTime.timeName() << endl;
+}
+

applications/solvers/heatTransfer/buoyantSimpleRadiationFoam/hEqn.H

@@ -12,7 +12,8 @@
 
     hEqn.relax();
 
-    hEqn.solve();
+    eqnResidual = hEqn.solve().initialResidual();
+    maxResidual = max(eqnResidual, maxResidual);
 
     thermo->correct();
 

applications/solvers/heatTransfer/buoyantSimpleRadiationFoam/initConvergenceCheck.H

@@ -0,0 +1,7 @@
+// initialize values for convergence checks
+
+    scalar eqnResidual = 1, maxResidual = 0;
+    scalar convergenceCriterion = 0;
+
+    simple.readIfPresent("convergence", convergenceCriterion);
+

applications/solvers/heatTransfer/buoyantSimpleRadiationFoam/pEqn.H

@@ -13,7 +13,16 @@ for (int nonOrth=0; nonOrth<=nNonOrthCorr; nonOrth++)
     );
 
     pdEqn.setReference(pdRefCell, pdRefValue);
-    pdEqn.solve();
+    // retain the residual from the first iteration
+    if (nonOrth == 0)
+    {
+        eqnResidual = pdEqn.solve().initialResidual();
+        maxResidual = max(eqnResidual, maxResidual);
+    }
+    else
+    {
+        pdEqn.solve();
+    }
 
     if (nonOrth == nNonOrthCorr)
     {

applications/solvers/incompressible/simpleFoam/UEqn.H

@@ -8,4 +8,10 @@
 
     UEqn().relax();
 
-    solve(UEqn() == -fvc::grad(p));
+    eqnResidual = solve
+    (
+        UEqn() == -fvc::grad(p)
+    ).initialResidual();
+
+    maxResidual = max(eqnResidual, maxResidual);
+

applications/solvers/incompressible/simpleFoam/convergenceCheck.H

@@ -0,0 +1,9 @@
+// check convergence
+
+if (maxResidual < convergenceCriterion)
+{
+    Info<< "reached convergence criterion: " << convergenceCriterion << endl;
+    runTime.writeAndEnd();
+    Info<< "latestTime = " << runTime.timeName() << endl;
+}
+

applications/solvers/incompressible/simpleFoam/initConvergenceCheck.H

@@ -0,0 +1,7 @@
+// initialize values for convergence checks
+
+    scalar eqnResidual = 1, maxResidual = 0;
+    scalar convergenceCriterion = 0;
+
+    simple.readIfPresent("convergence", convergenceCriterion);
+

applications/solvers/incompressible/simpleFoam/pEqn.H

@@ -15,7 +15,16 @@
         );
 
         pEqn.setReference(pRefCell, pRefValue);
-        pEqn.solve();
+        // retain the residual from the first iteration
+        if (nonOrth == 0)
+        {
+            eqnResidual = pEqn.solve().initialResidual();
+            maxResidual = max(eqnResidual, maxResidual);
+        }
+        else
+        {
+            pEqn.solve();
+        }
 
         if (nonOrth == nNonOrthCorr)
         {

applications/solvers/incompressible/simpleFoam/simpleFoam.C

@@ -54,6 +54,7 @@ int main(int argc, char *argv[])
         Info<< "Time = " << runTime.timeName() << nl << endl;
 
 #       include "readSIMPLEControls.H"
+#       include "initConvergenceCheck.H"
 
         p.storePrevIter();
 
@@ -70,6 +71,8 @@ int main(int argc, char *argv[])
         Info<< "ExecutionTime = " << runTime.elapsedCpuTime() << " s"
             << "  ClockTime = " << runTime.elapsedClockTime() << " s"
             << nl << endl;
+
+#       include "convergenceCheck.H"
     }
 
     Info<< "End\n" << endl;