src/foam/matrices/SquareMatrix/SquareMatrix.H

   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 Class
  25     Foam::SquareMatrix
  26
  27 Description
  28     A templated 2D square matrix of objects of \<T\>, where the n x n matrix
  29     dimension is known and used for subscript bounds checking, etc.
  30
  31 SourceFiles
  32     SquareMatrixI.H
  33     SquareMatrix.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef SquareMatrix_H
  38 #define SquareMatrix_H
  39
  40 #include "Matrix.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class Matrix Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class Type>
  52 class SquareMatrix
  53 :
  54     public Matrix<SquareMatrix<Type>, Type>
  55 {
  56
  57 public:
  58
  59     // Constructors
  60
  61         //- Null constructor.
  62         inline SquareMatrix();
  63
  64         //- Construct given number of rows/columns.
  65         inline SquareMatrix(const label n);
  66
  67         //- Construct with given number of rows and rows
  68         //  and value for all elements.
  69         inline SquareMatrix(const label n, const Type&);
  70
  71         //- Construct from Istream.
  72         inline SquareMatrix(Istream&);
  73
  74         //- Clone
  75         inline autoPtr<SquareMatrix<Type> > clone() const;
  76 };
  77
  78
  79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  80
  81 } // End namespace Foam
  82
  83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  84
  85 #   include "SquareMatrixI.H"
  86
  87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  88
  89 #endif
  90
  91 // ************************************************************************* //