src/OpenFOAM/matrices/SquareMatrix/SquareMatrix.H

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