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