src/coupledMatrix/coupledLduSolver/coupledSolverPerformance/coupledSolverPerformance.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Description
  25
  26 \*---------------------------------------------------------------------------*/
  27
  28 #include "coupledSolverPerformance.H"
  29
  30 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  31
  32 bool Foam::coupledSolverPerformance::checkConvergence
  33 (
  34     const scalar Tolerance,
  35     const scalar RelTolerance
  36 )
  37 {
  38     if (coupledLduMatrix::debug >= 2)
  39     {
  40         Info<< solverName_
  41             << ":  Iteration " << nIterations_
  42             << " residual = " << finalResidual_
  43             << endl;
  44     }
  45
  46     if
  47     (
  48         mag(finalResidual_) < Tolerance
  49      || (
  50             RelTolerance > SMALL
  51          && mag(finalResidual_) <= RelTolerance*mag(initialResidual_)
  52         )
  53     )
  54     {
  55         converged_ = true;
  56     }
  57     else
  58     {
  59         converged_ = false;
  60     }
  61
  62     return converged_;
  63 }
  64
  65
  66 bool Foam::coupledSolverPerformance::checkSingularity
  67 (
  68     const scalar& residual
  69 )
  70 {
  71     if (mag(residual) > VSMALL)
  72     {
  73         singular_ = false;
  74     }
  75     else
  76     {
  77         singular_ = true;
  78     }
  79
  80     return singular_;
  81 }
  82
  83
  84 void Foam::coupledSolverPerformance::print() const
  85 {
  86     if (coupledLduMatrix::debug)
  87     {
  88         Info<< solverName_ << ":  Solving for " << fieldName_;
  89
  90         if (singular())
  91         {
  92             Info<< ":  solution singularity" << endl;
  93         }
  94         else
  95         {
  96             Info<< ", Initial residual = " << initialResidual_
  97                 << ", Final residual = " << finalResidual_
  98                 << ", No Iterations " << nIterations_
  99                 << endl;
 100         }
 101     }
 102 }
 103
 104
 105 // ************************************************************************* //