src/OpenFOAM/matrices/scalarMatrix/scalarMatrix.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
   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 Class
  26     Foam::scalarMatrix
  27
  28 Description
  29     Foam::scalarMatrix
  30
  31 SourceFiles
  32     scalarMatrix.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef scalarMatrix_H
  37 #define scalarMatrix_H
  38
  39 #include "Matrix.H"
  40 #include "scalarField.H"
  41 #include "labelList.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class scalarMatrix Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class scalarMatrix
  53 :
  54     public Matrix<scalar>
  55 {
  56
  57 public:
  58
  59     // Constructors
  60
  61         //- Construct null
  62         scalarMatrix();
  63
  64         //- Construct given size
  65         scalarMatrix(const label);
  66
  67         //- Construct from Matrix<scalar>
  68         scalarMatrix(const Matrix<scalar>&);
  69
  70         //- Construct from Istream
  71         scalarMatrix(Istream&);
  72
  73
  74     // Member Functions
  75
  76         //- Solve the matrix using Gaussian elimination with pivoting,
  77         //  returning the solution in the source
  78         template<class T>
  79         static void solve(Matrix<scalar>& matrix, Field<T>& source);
  80
  81         //- Solve the matrix using Gaussian elimination with pivoting
  82         //  and return the solution
  83         template<class T>
  84         void solve(Field<T>& psi, const Field<T>& source) const;
  85
  86
  87         //- LU decompose the matrix with pivoting
  88         static void LUDecompose
  89         (
  90             Matrix<scalar>& matrix,
  91             labelList& pivotIndices
  92         );
  93
  94         //- LU back-substitution with given source, returning the solution
  95         //  in the source
  96         template<class T>
  97         static void LUBacksubstitute
  98         (
  99             const Matrix<scalar>& luMmatrix,
 100             const labelList& pivotIndices,
 101             Field<T>& source
 102         );
 103
 104         //- Solve the matrix using LU decomposition with pivoting
 105         //  returning the LU form of the matrix and the solution in the source
 106         template<class T>
 107         static void LUsolve(Matrix<scalar>& matrix, Field<T>& source);
 108 };
 109
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 } // End namespace Foam
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 #ifdef NoRepository
 118 #   include "scalarMatrixTemplates.C"
 119 #endif
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 #endif
 124
 125 // ************************************************************************* //