File size: 4,655 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 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 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::LUscalarMatrix
Description
Class to perform the LU decomposition on a symmetric matrix.
SourceFiles
LUscalarMatrix.C
\*---------------------------------------------------------------------------*/
#ifndef LUscalarMatrix_H
#define LUscalarMatrix_H
#include "scalarMatrices.H"
#include "labelList.H"
#include "Field.H"
#include "lduInterfaceFieldPtrsList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class lduMatrix;
class procLduMatrix;
/*---------------------------------------------------------------------------*\
Class LUscalarMatrix Declaration
\*---------------------------------------------------------------------------*/
class LUscalarMatrix
:
public scalarSquareMatrix
{
// Private Data
//- Communicator to use
const label comm_;
//- Processor matrix offsets
labelList procOffsets_;
//- The pivot indices used in the LU decomposition
labelList pivotIndices_;
// Private Member Functions
//- Convert the given lduMatrix into this LUscalarMatrix
void convert
(
const lduMatrix& ldum,
const Field<Field<scalar>>& interfaceCoeffs,
const lduInterfaceFieldPtrsList& interfaces
);
//- Convert the given list of procLduMatrix into this LUscalarMatrix
// on the master processor
void convert(const PtrList<procLduMatrix>& lduMatrices);
//- Print the ratio of the mag-sum of the off-diagonal coefficients
// to the mag-diagonal
void printDiagonalDominance() const;
public:
// Declare name of the class and its debug switch
ClassName("LUscalarMatrix");
// Constructors
//- Construct null
LUscalarMatrix();
//- Construct given number of rows/columns
LUscalarMatrix(const label n);
//- Construct from and perform LU decomposition of the matrix M
LUscalarMatrix(const scalarSquareMatrix& M);
//- Construct from lduMatrix and perform LU decomposition
LUscalarMatrix
(
const lduMatrix&,
const Field<Field<scalar>>& interfaceCoeffs,
const lduInterfaceFieldPtrsList& interfaces
);
// Member Functions
//- Perform the LU decomposition of the matrix
void decompose();
//- Perform the LU decomposition of the matrix M
void decompose(const scalarSquareMatrix& M);
//- Solve the linear system with the given source
// and returning the solution in the Field argument x.
// This function may be called with the same field for x and source.
template<class Type>
void solve(Field<Type>& x, const Field<Type>& source) const;
//- Solve the linear system with the given source
// returning the solution
template<class Type>
tmp<Field<Type>> solve(const Field<Type>& source) const;
//- Set M to the inverse of this square matrix
void inv(scalarSquareMatrix& M) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "LUscalarMatrixTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|