src/foam/matrices/blockLduMatrix/BlockLduSolvers/BlockIterativeSolver/BlockIterativeSolver.H

   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 Class
  25     BlockIterativeSolver
  26
  27 Description
  28     Virtual base class for a block iterative solvers
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 SourceFiles
  34     BlockIterativeSolver.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef BlockIterativeSolver_H
  39 #define BlockIterativeSolver_H
  40
  41 #include "BlockLduSolver.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                     Class BlockIterativeSolver Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 template<class Type>
  53 class BlockIterativeSolver
  54 :
  55     public BlockLduSolver<Type>
  56 {
  57     // Private data
  58
  59         //- Solver tolerance
  60         scalar tolerance_;
  61
  62         //- Relative tolerance
  63         scalar relTolerance_;
  64
  65         //- Minimum number of iterations
  66         //  (forced irrespective of convergence)
  67         label minIter_;
  68
  69         //- Maximum number of iterations
  70         label maxIter_;
  71
  72
  73     // Private Member Functions
  74
  75         //- Disallow default bitwise copy construct
  76         BlockIterativeSolver(const BlockIterativeSolver&);
  77
  78         //- Disallow default bitwise assignment
  79         void operator=(const BlockIterativeSolver&);
  80
  81
  82 protected:
  83
  84     // Protected Member Functions
  85
  86         //- Return normalisation factor
  87         scalar normFactor
  88         (
  89             Field<Type>& x,
  90             const Field<Type>& b
  91         ) const;
  92
  93         //- Is the stop criterion reached
  94         bool stop(BlockSolverPerformance<Type>& solverPerf) const;
  95
  96
  97 public:
  98
  99     // Constructors
 100
 101         //- Construct from matrix components and solver data stream
 102         BlockIterativeSolver
 103         (
 104             const word& fieldName,
 105             const BlockLduMatrix<Type>& matrix,
 106             const dictionary& dict
 107         );
 108
 109
 110     // Destructor
 111
 112         virtual ~BlockIterativeSolver()
 113         {}
 114
 115
 116     // Member Functions
 117
 118         // Access
 119
 120             //- Return tolerance
 121             scalar tolerance() const
 122             {
 123                 return tolerance_;
 124             }
 125
 126             //- Return relative tolerance
 127             scalar relTolerance() const
 128             {
 129                 return relTolerance_;
 130             }
 131
 132             //- Return minimum number of iterations
 133             label minIter() const
 134             {
 135                 return minIter_;
 136             }
 137
 138             //- Return maximum number of iterations
 139             label maxIter() const
 140             {
 141                 return maxIter_;
 142             }
 143
 144
 145         // Solve
 146
 147             //- Solve the matrix with this solver
 148             virtual BlockSolverPerformance<Type> solve
 149             (
 150                 Field<Type>& x,
 151                 const Field<Type>& b
 152             ) = 0;
 153 };
 154
 155
 156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 157
 158 } // End namespace Foam
 159
 160 #ifdef NoRepository
 161 #   include "BlockIterativeSolver.C"
 162 #endif
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 #endif
 167
 168 // ************************************************************************* //