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) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, 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 given number of rows and columns,
  68         //  It checks that m == n.
  69         inline SquareMatrix(const label m, const label n);
  70
  71         //- Construct with given number of rows and rows
  72         //  and value for all elements.
  73         //  It checks that m == n.
  74         inline SquareMatrix(const label m, const label n, const Type&);
  75
  76         //- Construct from Istream.
  77         inline SquareMatrix(Istream&);
  78
  79         //- Clone
  80         inline autoPtr<SquareMatrix<Type> > clone() const;
  81 };
  82
  83
  84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  85
  86 } // End namespace Foam
  87
  88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  89
  90 #   include "SquareMatrixI.H"
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 #endif
  95
  96 // ************************************************************************* //