src/OpenFOAM/matrices/simpleMatrix/simpleMatrix.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::simpleMatrix
  27
  28 Description
  29     Foam::simpleMatrix
  30
  31 SourceFiles
  32     simpleMatrix.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef simpleMatrix_H
  37 #define simpleMatrix_H
  38
  39 #include "scalarMatrix.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 // Forward declaration of friend functions and operators
  47
  48 template<class T>
  49 class simpleMatrix;
  50
  51 template<class T>
  52 simpleMatrix<T> operator+
  53 (
  54     const simpleMatrix<T>&,
  55     const simpleMatrix<T>&
  56 );
  57
  58 template<class T>
  59 simpleMatrix<T> operator-
  60 (
  61     const simpleMatrix<T>&,
  62     const simpleMatrix<T>&
  63 );
  64
  65 template<class T>
  66 simpleMatrix<T> operator*
  67 (
  68     const scalar,
  69     const simpleMatrix<T>&
  70 );
  71
  72 template<class T>
  73 Ostream& operator<<
  74 (
  75     Ostream&,
  76     const simpleMatrix<T>&
  77 );
  78
  79
  80 /*---------------------------------------------------------------------------*\
  81                            Class simpleMatrix Declaration
  82 \*---------------------------------------------------------------------------*/
  83
  84 template<class T>
  85 class simpleMatrix
  86 :
  87     public scalarMatrix
  88 {
  89     // Private data
  90
  91         Field<T> source_;
  92
  93
  94 public:
  95
  96     // Constructors
  97
  98         //- Construct given size
  99         simpleMatrix(const label);
 100
 101         //- Construct from components
 102         simpleMatrix(const scalarMatrix&, const Field<T>&);
 103
 104         //- Construct from Istream
 105         simpleMatrix(Istream&);
 106
 107         //- Construct as copy
 108         simpleMatrix(const simpleMatrix<T>&);
 109
 110
 111     // Member Functions
 112
 113         // Access
 114
 115             Field<T>& source()
 116             {
 117                 return source_;
 118             }
 119
 120             const Field<T>& source() const
 121             {
 122                 return source_;
 123             }
 124
 125
 126         //- Solve the matrix using Gaussian elimination with pivoting
 127         //  and return the solution
 128         Field<T> solve() const;
 129
 130         //- Solve the matrix using LU decomposition with pivoting
 131         //  and return the solution
 132         Field<T> LUsolve() const;
 133
 134
 135     // Member Operators
 136
 137         void operator=(const simpleMatrix<T>&);
 138
 139
 140     // Friend Operators
 141
 142         friend simpleMatrix<T> operator+ <T>
 143         (
 144             const simpleMatrix<T>&,
 145             const simpleMatrix<T>&
 146         );
 147
 148         friend simpleMatrix<T> operator- <T>
 149         (
 150             const simpleMatrix<T>&,
 151             const simpleMatrix<T>&
 152         );
 153
 154         friend simpleMatrix<T> operator* <T>
 155         (
 156             const scalar,
 157             const simpleMatrix<T>&
 158         );
 159
 160
 161     // Ostream Operator
 162
 163         friend Ostream& operator<< <T>
 164         (
 165             Ostream&,
 166             const simpleMatrix<T>&
 167         );
 168 };
 169
 170
 171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 172
 173 } // End namespace Foam
 174
 175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 176
 177 #ifdef NoRepository
 178 #   include "simpleMatrix.C"
 179 #endif
 180
 181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 182
 183 #endif
 184
 185 // ************************************************************************* //