File size: 3,863 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2020 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::DiagonalPreconditioner
Description
Diagonal preconditioner for both symmetric and asymmetric matrices.
The inverse (reciprocal for scalar) of the diagonal is calculated and
stored.
SourceFiles
DiagonalPreconditioner.C
\*---------------------------------------------------------------------------*/
#ifndef DiagonalPreconditioner_H
#define DiagonalPreconditioner_H
#include "LduMatrix.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class DiagonalPreconditioner Declaration
\*---------------------------------------------------------------------------*/
template<class Type, class DType, class LUType>
class DiagonalPreconditioner
:
public LduMatrix<Type, DType, LUType>::preconditioner
{
// Private Data
//- The inverse (reciprocal for scalar) diagonal
Field<DType> rD;
public:
//- Runtime type information
TypeName("diagonal");
// Constructors
//- Construct from matrix components and preconditioner data dictionary
DiagonalPreconditioner
(
const typename LduMatrix<Type, DType, LUType>::solver& sol,
const dictionary& preconditionerDict
);
//- Disallow default bitwise copy construction
DiagonalPreconditioner(const DiagonalPreconditioner&) = delete;
// Destructor
virtual ~DiagonalPreconditioner()
{}
// Member Functions
//- Read and reset the preconditioner parameters from the given
// dictionary
virtual void read(const dictionary& preconditionerDict);
//- Return wA the preconditioned form of residual rA
virtual void precondition
(
Field<Type>& wA,
const Field<Type>& rA
) const;
//- Return wT the transpose-matrix preconditioned form of
// residual rT.
virtual void preconditionT
(
Field<Type>& wT,
const Field<Type>& rT
) const
{
return(precondition(wT, rT));
}
// Member Operators
//- Disallow default bitwise assignment
void operator=(const DiagonalPreconditioner&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "DiagonalPreconditioner.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|