src/lduSolvers/lduPrecon/CholeskyPrecon/CholeskyPrecon.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     CholeskyPrecon
  26
  27 Description
  28     Incmplete Cholesky preconditioning with no fill-in for symmeytric matrices
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 SourceFiles
  34     CholeskyPrecon.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef CholeskyPrecon_H
  39 #define CholeskyPrecon_H
  40
  41 #include "lduMatrix.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                        Class CholeskyPrecon Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class CholeskyPrecon
  53 :
  54     public lduPreconditioner
  55 {
  56     // Private Data
  57
  58         //- Preconditioned diagonal
  59         scalarField preconDiag_;
  60
  61
  62     // Private Member Functions
  63
  64         //- Disallow default bitwise copy construct
  65         CholeskyPrecon(const CholeskyPrecon&);
  66
  67         //- Disallow default bitwise assignment
  68         void operator=(const CholeskyPrecon&);
  69
  70         //- Precondition the diagonal
  71         void calcPreconDiag();
  72
  73
  74 public:
  75
  76     //- Runtime type information
  77     TypeName("Cholesky");
  78
  79
  80     // Constructors
  81
  82         //- Construct from matrix and dictionary
  83         CholeskyPrecon
  84         (
  85             const lduMatrix& matrix,
  86             const FieldField<Field, scalar>& coupleBouCoeffs,
  87             const FieldField<Field, scalar>& coupleIntCoeffs,
  88             const lduInterfaceFieldPtrsList& interfaces,
  89             const dictionary& dict
  90         );
  91
  92         //- Construct from matrix as a smoother
  93         CholeskyPrecon
  94         (
  95             const lduMatrix& matrix,
  96             const FieldField<Field, scalar>& coupleBouCoeffs,
  97             const FieldField<Field, scalar>& coupleIntCoeffs,
  98             const lduInterfaceFieldPtrsList& interfaces
  99         );
 100
 101
 102     // Destructor
 103
 104         virtual ~CholeskyPrecon();
 105
 106
 107     // Member Functions
 108
 109         //- Execute preconditioning
 110         virtual void precondition
 111         (
 112             scalarField& wA,
 113             const scalarField& rA,
 114             const direction cmpt = 0
 115         ) const;
 116 };
 117
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 } // End namespace Foam
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 #endif
 126
 127 // ************************************************************************* //