src/coupledMatrix/coupledLduSolver/iterativeSolver/coupledIterativeSolver.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     Virtual base class for coupled iterative solvers
  26
  27 Author
  28     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
  29
  30 \*---------------------------------------------------------------------------*/
  31
  32 #include "coupledIterativeSolver.H"
  33
  34 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  35
  36 Foam::coupledIterativeSolver::coupledIterativeSolver
  37 (
  38     const word& fieldName,
  39     const coupledLduMatrix& matrix,
  40     const PtrList<FieldField<Field, scalar> >& bouCoeffs,
  41     const PtrList<FieldField<Field, scalar> >& intCoeffs,
  42     const lduInterfaceFieldPtrsListList& interfaces,
  43     const dictionary& solverData
  44 )
  45 :
  46     coupledLduSolver
  47     (
  48         fieldName,
  49         matrix,
  50         bouCoeffs,
  51         intCoeffs,
  52         interfaces
  53     ),
  54     dict_(solverData),
  55     tolerance_(1e-6),
  56     relTolerance_(0),
  57     minIter_(0),
  58     maxIter_(1000)
  59 {
  60     readControls();
  61 }
  62
  63
  64 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  65
  66 const Foam::dictionary& Foam::coupledIterativeSolver::dict() const
  67 {
  68     return dict_;
  69 }
  70
  71
  72 void Foam::coupledIterativeSolver::readControls()
  73 {
  74     dict().readIfPresent("minIter", minIter_);
  75     dict().readIfPresent("maxIter", maxIter_);
  76     dict().readIfPresent("tolerance", tolerance_);
  77     dict().readIfPresent("relTol", relTolerance_);
  78 }
  79
  80
  81 Foam::scalar Foam::coupledIterativeSolver::normFactor
  82 (
  83     const FieldField<Field, scalar>& x,
  84     const FieldField<Field, scalar>& b,
  85     const FieldField<Field, scalar>& Ax,
  86     FieldField<Field, scalar>& tmpField,
  87     const direction cmpt
  88 ) const
  89 {
  90     typedef FieldField<Field, scalar> scalarFieldField;
  91
  92     // Calculate reference value of x
  93     scalar xRef = gAverage(x);
  94
  95     scalarFieldField pA(x.size());
  96
  97     forAll (x, rowI)
  98     {
  99         pA.set(rowI, new scalarField(x[rowI].size(), xRef));
 100     }
 101
 102     // Calculate A.xRefField
 103     matrix_.Amul(tmpField, pA, bouCoeffs_, interfaces_, cmpt);
 104
 105     // Calculate the normalisation factor
 106     return gSum(mag(Ax - tmpField) + mag(b - tmpField)) + lduMatrix::small_;
 107 }
 108
 109
 110 Foam::scalar Foam::coupledIterativeSolver::normFactor
 111 (
 112     const FieldField<Field, scalar>& x,
 113     const FieldField<Field, scalar>& b,
 114     const direction cmpt
 115 ) const
 116 {
 117     typedef FieldField<Field, scalar> scalarFieldField;
 118
 119     scalarFieldField wA(x.size());
 120     scalarFieldField tmpField(x.size());
 121
 122     forAll (x, rowI)
 123     {
 124         wA.set(rowI, new scalarField(x[rowI].size(), 0));
 125         tmpField.set(rowI, new scalarField(x[rowI].size()));
 126     }
 127
 128     // Calculate A.x
 129     matrix_.Amul(wA, x, bouCoeffs_, interfaces_, cmpt);
 130
 131     return normFactor(x, b, wA, tmpField, cmpt);
 132 }
 133
 134
 135 bool Foam::coupledIterativeSolver::stop
 136 (
 137     coupledSolverPerformance& solverPerf
 138 ) const
 139 {
 140     if (solverPerf.nIterations() < minIter_)
 141     {
 142         return false;
 143     }
 144
 145     if
 146     (
 147         solverPerf.nIterations() >= maxIter_
 148      || solverPerf.checkConvergence(tolerance_, relTolerance_)
 149     )
 150     {
 151         return true;
 152     }
 153     else
 154     {
 155         return false;
 156     }
 157 }
 158
 159
 160 // ************************************************************************* //