File size: 3,773 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2021 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::QRMatrix
Description
Class templated on matrix type to perform the QR decomposition using
Householder reflections on a square or rectangular matrix.
SourceFiles
QRMatrixI.H
QRMatrix.C
\*---------------------------------------------------------------------------*/
#ifndef QRMatrix_H
#define QRMatrix_H
#include "SquareMatrix.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class QRMatrix Declaration
\*---------------------------------------------------------------------------*/
template<class MatrixType>
class QRMatrix
{
public:
typedef typename MatrixType::cmptType cmptType;
typedef SquareMatrix<cmptType> QMatrixType;
typedef MatrixType RMatrixType;
private:
// Private Data
//- The Q-matrix
QMatrixType Q_;
//- The R-matrix
RMatrixType R_;
// Private Member Functions
//- Solve the linear system with the Field argument x initialised to
// the appropriate transformed source (e.g. Q.T()*source)
// and return the solution in x
void solvex(Field<cmptType>& x) const;
public:
// Constructors
//- Construct null
inline QRMatrix();
//- Construct decomposing given matrix
QRMatrix(const MatrixType& M);
// Member Functions
//- Return Q-matrix
inline const QMatrixType& Q() const;
//- Return R-matrix
inline const RMatrixType& R() const;
//- Decompose given matrix
void decompose(const MatrixType& M);
//- Solve the linear system with the given source
// and returning the solution in the Field argument x
void solve(Field<cmptType>& x, const Field<cmptType>& source) const;
//- Solve the linear system with the given source
// returning the solution
tmp<Field<cmptType>> solve(const Field<cmptType>& source) const;
//- Return the inverse of a square matrix
QMatrixType inv() const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "QRMatrixI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "QRMatrix.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|