00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::SquareMatrix 00026 00027 Description 00028 A templated 2D square matrix of objects of <T>, where the n x n matrix 00029 dimension is known and used for subscript bounds checking, etc. 00030 00031 SourceFiles 00032 SquareMatrixI.H 00033 SquareMatrix.C 00034 00035 \*---------------------------------------------------------------------------*/ 00036 00037 #ifndef SquareMatrix_H 00038 #define SquareMatrix_H 00039 00040 #include <OpenFOAM/Matrix.H> 00041 00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00043 00044 namespace Foam 00045 { 00046 00047 /*---------------------------------------------------------------------------*\ 00048 Class Matrix Declaration 00049 \*---------------------------------------------------------------------------*/ 00050 00051 template<class Type> 00052 class SquareMatrix 00053 : 00054 public Matrix<SquareMatrix<Type>, Type> 00055 { 00056 00057 public: 00058 00059 // Constructors 00060 00061 //- Null constructor. 00062 inline SquareMatrix(); 00063 00064 //- Construct given number of rows/columns. 00065 inline SquareMatrix(const label n); 00066 00067 //- Construct given number of rows and columns, 00068 // It checks that m == n. 00069 inline SquareMatrix(const label m, const label n); 00070 00071 //- Construct with given number of rows and rows 00072 // and value for all elements. 00073 // It checks that m == n. 00074 inline SquareMatrix(const label m, const label n, const Type&); 00075 00076 //- Construct from Istream. 00077 inline SquareMatrix(Istream&); 00078 00079 //- Clone 00080 inline autoPtr<SquareMatrix<Type> > clone() const; 00081 }; 00082 00083 00084 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00085 00086 } // End namespace Foam 00087 00088 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00089 00090 # include "SquareMatrixI.H" 00091 00092 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00093 00094 #endif 00095 00096 // ************************ vim: set sw=4 sts=4 et: ************************ //
