src/lduSolvers/lduSmoother/symGaussSeidelSmoother/symGaussSeidelSmoother.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     symGaussSeidelSmoother
  26
  27 Description
  28     Symmetric Gauss-Seidel smoother
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 SourceFiles
  34     symGaussSeidelSmoother.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef symGaussSeidelSmoother_H
  39 #define symGaussSeidelSmoother_H
  40
  41 #include "symGaussSeidelPrecon.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                     Class symGaussSeidelSmoother Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class symGaussSeidelSmoother
  53 :
  54     public lduSmoother
  55 {
  56     // Private Data
  57
  58         //- Gauss-Seidel preconditioner
  59         symGaussSeidelPrecon gs_;
  60
  61
  62     // Private Member Functions
  63
  64         //- Disallow default bitwise copy construct
  65         symGaussSeidelSmoother(const symGaussSeidelSmoother&);
  66
  67         //- Disallow default bitwise assignment
  68         void operator=(const symGaussSeidelSmoother&);
  69
  70
  71 public:
  72
  73     //- Runtime type information
  74     TypeName("symGaussSeidel");
  75
  76
  77     // Constructors
  78
  79         //- Construct from components
  80         symGaussSeidelSmoother
  81         (
  82             const lduMatrix& matrix,
  83             const FieldField<Field, scalar>& coupleBouCoeffs,
  84             const FieldField<Field, scalar>& coupleIntCoeffs,
  85             const lduInterfaceFieldPtrsList& interfaces
  86         );
  87
  88
  89     // Destructor
  90
  91         virtual ~symGaussSeidelSmoother()
  92         {}
  93
  94
  95     // Member Functions
  96
  97         //- Execute smoothing
  98         virtual void smooth
  99         (
 100             scalarField& x,
 101             const scalarField& b,
 102             const direction cmpt,
 103             const label nSweeps
 104         ) const;
 105 };
 106
 107
 108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 109
 110 } // End namespace Foam
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 #endif
 115
 116 // ************************************************************************* //