src/foam/matrices/scalarMatrices/scalarSquareMatrix.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 \*---------------------------------------------------------------------------*/
  25
  26 #include "scalarSquareMatrix.H"
  27
  28 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  29
  30 Foam::scalarSquareMatrix::scalarSquareMatrix()
  31 {}
  32
  33
  34 Foam::scalarSquareMatrix::scalarSquareMatrix(const label mSize)
  35 :
  36     SquareMatrix<scalar>(mSize, 0.0)
  37 {}
  38
  39
  40 Foam::scalarSquareMatrix::scalarSquareMatrix
  41 (
  42     const label mSize,
  43     const scalar v
  44 )
  45 :
  46     SquareMatrix<scalar>(mSize, v)
  47 {}
  48
  49
  50 Foam::scalarSquareMatrix::scalarSquareMatrix(const scalarSquareMatrix& matrix)
  51 :
  52     SquareMatrix<scalar>(matrix)
  53 {}
  54
  55
  56 Foam::scalarSquareMatrix::scalarSquareMatrix(Istream& is)
  57 :
  58     SquareMatrix<scalar>(is)
  59 {}
  60
  61
  62 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  63
  64 void Foam::scalarSquareMatrix::LUDecompose
  65 (
  66     scalarSquareMatrix& matrix,
  67     labelList& pivotIndices
  68 )
  69 {
  70     label n = matrix.n();
  71     scalar vv[n];
  72
  73     for (register label i=0; i<n; i++)
  74     {
  75         scalar largestCoeff = 0.0;
  76         scalar temp;
  77         const scalar* __restrict__ matrixi = matrix[i];
  78
  79         for (register label j=0; j<n; j++)
  80         {
  81             if ((temp = mag(matrixi[j])) > largestCoeff)
  82             {
  83                 largestCoeff = temp;
  84             }
  85         }
  86
  87         if (largestCoeff == 0.0)
  88         {
  89             FatalErrorIn
  90             (
  91                 "scalarSquareMatrix::LUdecompose"
  92                 "(scalarSquareMatrix& matrix, labelList& rowIndices)"
  93             )   << "Singular matrix" << exit(FatalError);
  94         }
  95
  96         vv[i] = 1.0/largestCoeff;
  97     }
  98
  99     for (register label j=0; j<n; j++)
 100     {
 101         scalar* __restrict__ matrixj = matrix[j];
 102
 103         for (register label i=0; i<j; i++)
 104         {
 105             scalar* __restrict__ matrixi = matrix[i];
 106
 107             scalar sum = matrixi[j];
 108             for (register label k=0; k<i; k++)
 109             {
 110                 sum -= matrixi[k]*matrix[k][j];
 111             }
 112             matrixi[j] = sum;
 113         }
 114
 115         label iMax = 0;
 116
 117         scalar largestCoeff = 0.0;
 118         for (register label i=j; i<n; i++)
 119         {
 120             scalar* __restrict__ matrixi = matrix[i];
 121             scalar sum = matrixi[j];
 122
 123             for (register label k=0; k<j; k++)
 124             {
 125                 sum -= matrixi[k]*matrix[k][j];
 126             }
 127
 128             matrixi[j] = sum;
 129
 130             scalar temp;
 131             if ((temp = vv[i]*mag(sum)) >= largestCoeff)
 132             {
 133                 largestCoeff = temp;
 134                 iMax = i;
 135             }
 136         }
 137
 138         pivotIndices[j] = iMax;
 139
 140         if (j != iMax)
 141         {
 142             scalar* __restrict__ matrixiMax = matrix[iMax];
 143
 144             for (register label k=0; k<n; k++)
 145             {
 146                 Swap(matrixj[k], matrixiMax[k]);
 147             }
 148
 149             vv[iMax] = vv[j];
 150         }
 151
 152         if (matrixj[j] == 0.0)
 153         {
 154             matrixj[j] = SMALL;
 155         }
 156
 157         if (j != n-1)
 158         {
 159             scalar rDiag = 1.0/matrixj[j];
 160
 161             for (register label i=j+1; i<n; i++)
 162             {
 163                 matrix[i][j] *= rDiag;
 164             }
 165         }
 166     }
 167 }
 168
 169
 170 Foam::scalarSquareMatrix Foam::scalarSquareMatrix::LUinvert() const
 171 {
 172     scalarSquareMatrix luMatrix = *this;
 173
 174     scalarSquareMatrix luInvert(luMatrix.n());
 175     scalarField column(luMatrix.n());
 176
 177     labelList pivotIndices(luMatrix.n());
 178
 179     LUDecompose(luMatrix, pivotIndices);
 180
 181     for (label j = 0; j < luMatrix.n(); j++)
 182     {
 183         for (label i = 0; i < luMatrix.n(); i++)
 184         {
 185             column[i] = 0.0;
 186         }
 187
 188         column[j] = 1.0;
 189
 190         LUBacksubstitute(luMatrix, pivotIndices, column);
 191
 192         for (label i = 0; i < luMatrix.n(); i++)
 193         {
 194             luInvert[i][j] = column[i];
 195         }
 196     }
 197
 198     return luInvert;
 199 }
 200
 201
 202 // ************************************************************************* //