src/lduSolvers/lduSmoother/symGaussSeidelSmoother/symGaussSeidelSmoother.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 Class
  25     symGaussSeidelSmoother
  26
  27 Description
  28     Symmetric Gauss-Seidel smoother
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #include "symGaussSeidelSmoother.H"
  36 #include "addToRunTimeSelectionTable.H"
  37
  38 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42     defineTypeNameAndDebug(symGaussSeidelSmoother, 0);
  43
  44     lduSmoother::addsymMatrixConstructorToTable<symGaussSeidelSmoother>
  45         addGaussSeidelSmootherSymMatrixConstructorToTable_;
  46
  47     lduSmoother::addasymMatrixConstructorToTable<symGaussSeidelSmoother>
  48         addGaussSeidelSmootherAsymMatrixConstructorToTable_;
  49 }
  50
  51
  52 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  53
  54 Foam::symGaussSeidelSmoother::symGaussSeidelSmoother
  55 (
  56     const lduMatrix& matrix,
  57     const FieldField<Field, scalar>& coupleBouCoeffs,
  58     const FieldField<Field, scalar>& coupleIntCoeffs,
  59     const lduInterfaceFieldPtrsList& interfaces
  60 )
  61 :
  62     lduSmoother
  63     (
  64         matrix,
  65         coupleBouCoeffs,
  66         coupleIntCoeffs,
  67         interfaces
  68     ),
  69     gs_
  70     (
  71         matrix,
  72         coupleBouCoeffs,
  73         coupleIntCoeffs,
  74         interfaces
  75     )
  76 {}
  77
  78
  79 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  80
  81 void Foam::symGaussSeidelSmoother::smooth
  82 (
  83     scalarField& x,
  84     const scalarField& b,
  85     const direction cmpt,
  86     const label nSweeps
  87 ) const
  88 {
  89     for (label sweep = 0; sweep < nSweeps; sweep++)
  90     {
  91         gs_.precondition(x, b, cmpt);
  92     }
  93 }
  94
  95
  96 // ************************************************************************* //