SquareMatrixI.H
Go to the documentation of this file.
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 \*---------------------------------------------------------------------------*/
25 
26 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
27 
28 template<class Type>
30 :
31  Matrix<SquareMatrix<Type>, Type>()
32 {}
33 
34 template<class Type>
36 :
37  Matrix<SquareMatrix<Type>, Type>(n, n)
38 {}
39 
40 template<class Type>
42 :
43  Matrix<SquareMatrix<Type>, Type>(m, n)
44 {
45  if (m != n)
46  {
48  (
49  "SquareMatrix<Type>::SquareMatrix(const label m, const label n)"
50  ) << "m != n for constructing a square matrix" << exit(FatalError);
51  }
52 }
53 
54 template<class Type>
56 (
57  const label m,
58  const label n,
59  const Type& t
60 )
61 :
62  Matrix<SquareMatrix<Type>, Type>(m, n, t)
63 {
64  if (m != n)
65  {
67  (
68  "SquareMatrix<Type>::SquareMatrix"
69  "(const label m, const label n, const Type&)"
70  ) << "m != n for constructing a square matrix" << exit(FatalError);
71  }
72 }
73 
74 template<class Type>
76 :
77  Matrix<SquareMatrix<Type>, Type>(is)
78 {}
79 
80 template<class Type>
83 {
85 }
86 
87 
88 // ************************************************************************* //
A templated 2D matrix of objects of <T>, where the n x m matrix dimensions are known and used for sub...
label n() const
Return the number of rows.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
autoPtr< SquareMatrix< Type > > clone() const
Clone.
Definition: SquareMatrixI.H:82
#define FatalErrorIn(functionName)
Report an error message using Foam::FatalError.
Definition: error.H:314
SquareMatrix()
Null constructor.
Definition: SquareMatrixI.H:29
error FatalError
A templated 2D square matrix of objects of <T>, where the n x n matrix dimension is known and used fo...
Definition: SquareMatrix.H:51
label m() const
Return the number of columns.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117