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