src/blockMatrix/BlockLduSmoothers/BlockGaussSeidelSmoother/BlockGaussSeidelSmoother.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-6 H. Jasak All rights reserved
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     BlockGaussSeidelSmoother
  27
  28 Description
  29     Symmetric Gauss-Seidel smoother with prescribed number of smoothing sweeps
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
  33
  34 SourceFiles
  35     blockGaussSeidelSmoothers.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef BlockGaussSeidelSmoother_H
  40 #define BlockGaussSeidelSmoother_H
  41
  42 #include "BlockLduSmoother.H"
  43 #include "blockGaussSeidelPrecons.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                    Class BlockGaussSeidelSmoother Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template<class Type>
  55 class BlockGaussSeidelSmoother
  56 :
  57     public BlockLduSmoother<Type>
  58 {
  59     // Private Data
  60
  61         //- Gauss-Seidel preconditioner
  62         BlockGaussSeidelPrecon<Type> gs_;
  63
  64
  65     // Private Member Functions
  66
  67         //- Disallow default bitwise copy construct
  68         BlockGaussSeidelSmoother(const BlockGaussSeidelSmoother&);
  69
  70         //- Disallow default bitwise assignment
  71         void operator=(const BlockGaussSeidelSmoother&);
  72
  73
  74 public:
  75
  76     //- Runtime type information
  77     TypeName("GaussSeidel");
  78
  79
  80     // Constructors
  81
  82         //- Construct from components
  83         BlockGaussSeidelSmoother
  84         (
  85             const BlockLduMatrix<Type>& matrix,
  86             const dictionary& dict
  87         )
  88         :
  89             BlockLduSmoother<Type>(matrix),
  90             gs_(matrix)
  91         {}
  92
  93
  94     // Destructor
  95
  96         virtual ~BlockGaussSeidelSmoother()
  97         {}
  98
  99
 100     // Member Functions
 101
 102         //- Execute smoothing
 103         virtual void smooth
 104         (
 105             Field<Type>& x,
 106             const Field<Type>& b,
 107             const label nSweeps
 108         ) const
 109         {
 110             for (label sweep = 0; sweep < nSweeps; sweep++)
 111             {
 112                 gs_.precondition(x, b);
 113             }
 114         }
 115 };
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace Foam
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #endif
 125
 126 // ************************************************************************* //