src/coupledMatrix/coupledLduSmoother/GaussSeidelSmoother/coupledGaussSeidelSmoother.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 Description
  25     Symmetric Gauss-Seidel smoother for coupled lduMatrices.
  26
  27 Author
  28     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
  29
  30 \*---------------------------------------------------------------------------*/
  31
  32 #include "coupledGaussSeidelSmoother.H"
  33 #include "addToRunTimeSelectionTable.H"
  34
  35 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  36
  37 namespace Foam
  38 {
  39     defineTypeNameAndDebug(coupledGaussSeidelSmoother, 0);
  40
  41     addToRunTimeSelectionTable
  42     (
  43         coupledLduSmoother,
  44         coupledGaussSeidelSmoother,
  45         word
  46     );
  47 }
  48
  49 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  50
  51 //- Construct from matrix
  52 Foam::coupledGaussSeidelSmoother::coupledGaussSeidelSmoother
  53 (
  54     const coupledLduMatrix& matrix,
  55     const PtrList<FieldField<Field, scalar> >& bouCoeffs,
  56     const PtrList<FieldField<Field, scalar> >& intCoeffs,
  57     const lduInterfaceFieldPtrsListList& interfaces
  58 )
  59 :
  60     coupledLduSmoother
  61     (
  62         matrix,
  63         bouCoeffs,
  64         intCoeffs,
  65         interfaces
  66     ),
  67     gs_
  68     (
  69         matrix,
  70         bouCoeffs,
  71         intCoeffs,
  72         interfaces
  73     )
  74 {}
  75
  76
  77 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  78
  79 void Foam::coupledGaussSeidelSmoother::smooth
  80 (
  81     FieldField<Field, scalar>& x,
  82     const FieldField<Field, scalar>& b,
  83     const direction cmpt,
  84     const label nSweeps
  85 ) const
  86 {
  87     for (label sweep = 0; sweep < nSweeps; sweep++)
  88     {
  89         gs_.precondition(x, b, cmpt);
  90     }
  91 }
  92
  93
  94 // ************************************************************************* //