src/OpenFOAM/matrices/scalarMatrices/scalarSquareMatrixTemplates.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM 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 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 \*---------------------------------------------------------------------------*/
  26
  27 #include "scalarSquareMatrix.H"
  28 #include "Swap.H"
  29
  30 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  31
  32 template<class Type>
  33 void Foam::scalarSquareMatrix::solve
  34 (
  35     scalarSquareMatrix& tmpMatrix,
  36     Field<Type>& sourceSol
  37 )
  38 {
  39     label n = tmpMatrix.n();
  40
  41     // Elimination
  42     for (register label i=0; i<n; i++)
  43     {
  44         label iMax = i;
  45         scalar largestCoeff = mag(tmpMatrix[iMax][i]);
  46
  47         // Swap entries around to find a good pivot
  48         for (register label j=i+1; j<n; j++)
  49         {
  50             if (mag(tmpMatrix[j][i]) > largestCoeff)
  51             {
  52                 iMax = j;
  53                 largestCoeff = mag(tmpMatrix[iMax][i]);
  54             }
  55         }
  56
  57         if (i != iMax)
  58         {
  59             //Info<< "Pivoted on " << i << " " << iMax << endl;
  60
  61             for (register label k=i; k<n; k++)
  62             {
  63                 Swap(tmpMatrix[i][k], tmpMatrix[iMax][k]);
  64             }
  65             Swap(sourceSol[i], sourceSol[iMax]);
  66         }
  67
  68         // Check that the system of equations isn't singular
  69         if (mag(tmpMatrix[i][i]) < 1e-20)
  70         {
  71             FatalErrorIn("solve(scalarSquareMatrix&, Field<Type>& sourceSol)")
  72                 << "Singular Matrix"
  73                 << exit(FatalError);
  74         }
  75
  76         // Reduce to upper triangular form
  77         for (register label j=i+1; j<n; j++)
  78         {
  79             sourceSol[j] -= sourceSol[i]*(tmpMatrix[j][i]/tmpMatrix[i][i]);
  80
  81             for (register label k=n-1; k>=i; k--)
  82             {
  83                 tmpMatrix[j][k] -=
  84                     tmpMatrix[i][k]*tmpMatrix[j][i]/tmpMatrix[i][i];
  85             }
  86         }
  87     }
  88
  89     // Back-substitution
  90     for (register label j=n-1; j>=0; j--)
  91     {
  92         Type ntempvec = pTraits<Type>::zero;
  93
  94         for (register label k=j+1; k<n; k++)
  95         {
  96             ntempvec += tmpMatrix[j][k]*sourceSol[k];
  97         }
  98
  99         sourceSol[j] = (sourceSol[j] - ntempvec)/tmpMatrix[j][j];
 100     }
 101 }
 102
 103
 104 template<class Type>
 105 void Foam::scalarSquareMatrix::solve
 106 (
 107     Field<Type>& psi,
 108     const Field<Type>& source
 109 ) const
 110 {
 111     scalarSquareMatrix tmpMatrix = *this;
 112     psi = source;
 113     solve(tmpMatrix, psi);
 114 }
 115
 116
 117 template<class Type>
 118 void Foam::scalarSquareMatrix::LUBacksubstitute
 119 (
 120     const scalarSquareMatrix& luMatrix,
 121     const labelList& pivotIndices,
 122     Field<Type>& sourceSol
 123 )
 124 {
 125     label n = luMatrix.n();
 126
 127     label ii = 0;
 128
 129     for (register label i=0; i<n; i++)
 130     {
 131         label ip = pivotIndices[i];
 132         Type sum = sourceSol[ip];
 133         sourceSol[ip] = sourceSol[i];
 134         const scalar* __restrict__ luMatrixi = luMatrix[i];
 135
 136         if (ii != 0)
 137         {
 138             for (label j=ii-1; j<i; j++)
 139             {
 140                 sum -= luMatrixi[j]*sourceSol[j];
 141             }
 142         }
 143         else if (sum != pTraits<Type>::zero)
 144         {
 145             ii = i+1;
 146         }
 147
 148         sourceSol[i] = sum;
 149     }
 150
 151     for (register label i=n-1; i>=0; i--)
 152     {
 153         Type sum = sourceSol[i];
 154         const scalar* __restrict__ luMatrixi = luMatrix[i];
 155
 156         for (register label j=i+1; j<n; j++)
 157         {
 158             sum -= luMatrixi[j]*sourceSol[j];
 159         }
 160
 161         sourceSol[i] = sum/luMatrixi[i];
 162     }
 163 }
 164
 165
 166 template<class Type>
 167 void Foam::scalarSquareMatrix::LUsolve
 168 (
 169     scalarSquareMatrix& matrix,
 170     Field<Type>& sourceSol
 171 )
 172 {
 173     labelList pivotIndices(matrix.n());
 174     LUDecompose(matrix, pivotIndices);
 175     LUBacksubstitute(matrix, pivotIndices, sourceSol);
 176 }
 177
 178
 179 // ************************************************************************* //