src/foam/matrices/blockLduMatrix/BlockLduSolvers/BlockGMRES/BlockGMRESSolver.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     BlockGMRESSolver
  26
  27 Description
  28     Preconditioned Generalised Minimal Residual solver with
  29     run-time selectable preconditioning
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  33
  34 SourceFiles
  35     BlockGMRESSolver.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef BlockGMRESSolver_H
  40 #define BlockGMRESSolver_H
  41
  42 #include "blockLduSolvers.H"
  43 #include "BlockIterativeSolver.H"
  44 #include "blockLduPrecons.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                        Class BlockGMRESSolver Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 template<class Type>
  56 class BlockGMRESSolver
  57 :
  58     public BlockIterativeSolver<Type>
  59 {
  60     // Private data
  61
  62         //- Preconditioner
  63         autoPtr<BlockLduPrecon<Type> > preconPtr_;
  64
  65         //- Krylov space dimension
  66         label nDirs_;
  67
  68
  69     // Private Member Functions
  70
  71         //- Disallow default bitwise copy construct
  72         BlockGMRESSolver(const BlockGMRESSolver<Type>&);
  73
  74         //- Disallow default bitwise assignment
  75         void operator=(const BlockGMRESSolver<Type>&);
  76
  77         //- Givens rotation
  78         void givensRotation
  79         (
  80             const scalar& H,
  81             const scalar& beta,
  82             scalar& c,
  83             scalar& s
  84         ) const;
  85
  86
  87 public:
  88
  89     //- Runtime type information
  90     TypeName("GMRES");
  91
  92
  93     // Constructors
  94
  95         //- Construct from matrix components and solver data stream
  96         BlockGMRESSolver
  97         (
  98             const word& fieldName,
  99             const BlockLduMatrix<Type>& matrix,
 100             const dictionary& dict
 101         );
 102
 103
 104         // Destructor
 105
 106             virtual ~BlockGMRESSolver()
 107             {}
 108
 109
 110     // Member Functions
 111
 112         //- Solve the matrix with this solver
 113         virtual BlockSolverPerformance<Type> solve
 114         (
 115             Field<Type>& x,
 116             const Field<Type>& b
 117         );
 118 };
 119
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 } // End namespace Foam
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 #ifdef NoRepository
 128 #   include "BlockGMRESSolver.C"
 129 #endif
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 #endif
 134
 135 // ************************************************************************* //