src/lduSolvers/lduPrecon/CholeskyPrecon/CholeskyPrecon.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 Class
  25     CholeskyPrecon
  26
  27 Description
  28     Incmplete Cholesky preconditioning with no fill-in
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #include "CholeskyPrecon.H"
  36 #include "addToRunTimeSelectionTable.H"
  37
  38 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42     defineTypeNameAndDebug(CholeskyPrecon, 0);
  43
  44     lduPreconditioner::
  45         addsymMatrixConstructorToTable<CholeskyPrecon>
  46         addCholeskyPreconditionerSymMatrixConstructorToTable_;
  47 }
  48
  49
  50 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
  51
  52 void Foam::CholeskyPrecon::calcPreconDiag()
  53 {
  54     // Precondition the diagonal
  55     if (matrix_.symmetric())
  56     {
  57         const unallocLabelList& upperAddr = matrix_.lduAddr().upperAddr();
  58         const unallocLabelList& lowerAddr = matrix_.lduAddr().lowerAddr();
  59
  60         // Get off-diagonal matrix coefficients
  61         const scalarField& upper = matrix_.upper();
  62
  63         forAll (upper, coeffI)
  64         {
  65             preconDiag_[upperAddr[coeffI]] -=
  66                 sqr(upper[coeffI])/preconDiag_[lowerAddr[coeffI]];
  67         }
  68     }
  69
  70     // Invert the diagonal for future use
  71     forAll (preconDiag_, i)
  72     {
  73         preconDiag_[i] = 1.0/preconDiag_[i];
  74     }
  75 }
  76
  77
  78 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  79
  80 Foam::CholeskyPrecon::CholeskyPrecon
  81 (
  82     const lduMatrix& matrix,
  83     const FieldField<Field, scalar>& coupleBouCoeffs,
  84     const FieldField<Field, scalar>& coupleIntCoeffs,
  85     const lduInterfaceFieldPtrsList& interfaces,
  86     const dictionary& dict
  87 )
  88 :
  89     lduPreconditioner
  90     (
  91         matrix,
  92         coupleBouCoeffs,
  93         coupleIntCoeffs,
  94         interfaces
  95     ),
  96     preconDiag_(matrix_.diag())
  97 {
  98     calcPreconDiag();
  99 }
 100
 101
 102 Foam::CholeskyPrecon::CholeskyPrecon
 103 (
 104     const lduMatrix& matrix,
 105     const FieldField<Field, scalar>& coupleBouCoeffs,
 106     const FieldField<Field, scalar>& coupleIntCoeffs,
 107     const lduInterfaceFieldPtrsList& interfaces
 108 )
 109 :
 110     lduPreconditioner
 111     (
 112         matrix,
 113         coupleBouCoeffs,
 114         coupleIntCoeffs,
 115         interfaces
 116     ),
 117     preconDiag_(matrix_.diag())
 118 {
 119     calcPreconDiag();
 120 }
 121
 122
 123 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 124
 125 Foam::CholeskyPrecon::~CholeskyPrecon()
 126 {}
 127
 128
 129 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 130
 131 void Foam::CholeskyPrecon::precondition
 132 (
 133     scalarField& x,
 134     const scalarField& b,
 135     const direction
 136 ) const
 137 {
 138     forAll(x, i)
 139     {
 140         x[i] = b[i]*preconDiag_[i];
 141     }
 142
 143     if (matrix_.symmetric())
 144     {
 145         const unallocLabelList& upperAddr = matrix_.lduAddr().upperAddr();
 146         const unallocLabelList& lowerAddr = matrix_.lduAddr().lowerAddr();
 147
 148         // Get off-diagonal matrix coefficients
 149         const scalarField& upper = matrix_.upper();
 150
 151         forAll (upper, coeffI)
 152         {
 153             x[upperAddr[coeffI]] -=
 154                 preconDiag_[upperAddr[coeffI]]*
 155                 upper[coeffI]*x[lowerAddr[coeffI]];
 156         }
 157
 158         forAllReverse (upper, coeffI)
 159         {
 160             x[lowerAddr[coeffI]] -=
 161                 preconDiag_[lowerAddr[coeffI]]*
 162                 upper[coeffI]*x[upperAddr[coeffI]];
 163         }
 164     }
 165 }
 166
 167
 168 // ************************************************************************* //