src/foam/matrices/lduMatrix/preconditioners/DICPreconditioner/DICPreconditioner.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     Foam::DICPreconditioner
  26
  27 Description
  28     Simplified diagonal-based incomplete Cholesky preconditioner for symmetric
  29     matrices (symmetric equivalent of DILU).  The reciprocal of the
  30     preconditioned diagonal is calculated and stored.
  31
  32 SourceFiles
  33     DICPreconditioner.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef DICPreconditioner_H
  38 #define DICPreconditioner_H
  39
  40 #include "lduMatrix.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class DICPreconditioner Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class DICPreconditioner
  52 :
  53     public lduPreconditioner
  54 {
  55     // Private data
  56
  57         //- The reciprocal preconditioned diagonal
  58         scalarField rD_;
  59
  60
  61 public:
  62
  63     //- Runtime type information
  64     TypeName("DIC");
  65
  66
  67     // Constructors
  68
  69         //- Construct from matrix components and preconditioner solver controls
  70         DICPreconditioner
  71         (
  72             const lduMatrix& matrix,
  73             const FieldField<Field, scalar>& coupleBouCoeffs,
  74             const FieldField<Field, scalar>& coupleIntCoeffs,
  75             const lduInterfaceFieldPtrsList& interfaces,
  76             const dictionary& dict
  77         );
  78
  79
  80     // Destructor
  81
  82         virtual ~DICPreconditioner()
  83         {}
  84
  85
  86     // Member Functions
  87
  88         //- Calculate the reciprocal of the preconditioned diagonal
  89         static void calcReciprocalD(scalarField& rD, const lduMatrix& matrix);
  90
  91         //- Execute preconditioning
  92         virtual void precondition
  93         (
  94             scalarField& wA,
  95             const scalarField& rA,
  96             const direction cmpt = 0
  97         ) const;
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #endif
 108
 109 // ************************************************************************* //