src/OpenFOAM/matrices/DiagonalMatrix/DiagonalMatrix.H

   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 Class
  26     Foam::DiagonalMatrix<Type>
  27
  28 Description
  29     DiagonalMatrix<Type> is a 2D diagonal matrix of objects
  30     of type Type, size nxn
  31
  32 SourceFiles
  33     DiagonalMatrix.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef DiagonalMatrix_H
  38 #define DiagonalMatrix_H
  39
  40 #include "List.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // * * * * * *  * * * * * * Class Forward declaration  * * * * * * * * * * * //
  48
  49 template<class Form, class Type> class Matrix;
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Class DiagonalMatrix Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 template<class Type>
  56 class DiagonalMatrix
  57 :
  58     public List<Type>
  59 {
  60 public:
  61
  62     // Constructors
  63
  64         //- Construct from diagonal component of a Matrix
  65         template<class Form>
  66         DiagonalMatrix<Type>(const Matrix<Form, Type>&);
  67
  68         //- Construct empty from size
  69         DiagonalMatrix<Type>(const label size);
  70
  71         //- Construct from size and a value
  72         DiagonalMatrix<Type>(const label, const Type&);
  73
  74
  75     // Member functions
  76
  77         //- Invert the diaganol matrix and return itself
  78         DiagonalMatrix<Type>& invert();
  79 };
  80
  81
  82 // Global functions
  83
  84 //- Return the diagonal Matrix inverse
  85 template<class Type>
  86 DiagonalMatrix<Type> inv(const DiagonalMatrix<Type>&);
  87
  88
  89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  90
  91 } // End namespace Foam
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 #ifdef NoRepository
  96 #   include "DiagonalMatrix.C"
  97 #endif
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 #endif
 102
 103 // ************************************************************************* //