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