DiagonalPreconditioner.C
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2015 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26\*---------------------------------------------------------------------------*/
27
29
30// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
31
32template<class Type, class DType, class LUType>
34(
36 const dictionary&
37)
38:
39 LduMatrix<Type, DType, LUType>::preconditioner(sol),
40 rD(sol.matrix().diag().size())
41{
42 DType* __restrict__ rDPtr = rD.begin();
43 const DType* __restrict__ DPtr = this->solver_.matrix().diag().begin();
44
45 label nCells = rD.size();
46
47 // Generate inverse (reciprocal for scalar) diagonal
48 for (label cell=0; cell<nCells; cell++)
49 {
50 rDPtr[cell] = inv(DPtr[cell]);
51 }
52}
53
54
55// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
56
57template<class Type, class DType, class LUType>
59{}
60
61
62template<class Type, class DType, class LUType>
64(
65 Field<Type>& wA,
66 const Field<Type>& rA
67) const
68{
69 Type* __restrict__ wAPtr = wA.begin();
70 const Type* __restrict__ rAPtr = rA.begin();
71 const DType* __restrict__ rDPtr = rD.begin();
72
73 label nCells = wA.size();
74
75 for (label cell=0; cell<nCells; cell++)
76 {
77 wAPtr[cell] = dot(rDPtr[cell], rAPtr[cell]);
78 }
79}
80
81
82// ************************************************************************* //
Diagonal preconditioner for both symmetric and asymmetric matrices.
virtual void precondition(Field< Type > &wA, const Field< Type > &rA) const
Return wA the preconditioned form of residual rA.
Generic templated field type.
Definition: Field.H:82
const solver & solver_
Reference to the base-solver this preconditioner is used with.
Definition: LduMatrix.H:369
Abstract base-class for LduMatrix solvers.
Definition: LduMatrix.H:116
LduMatrix is a general matrix class in which the coefficients are stored as three arrays,...
Definition: LduMatrix.H:88
virtual bool read()
Re-read model coefficients if they have changed.
iterator begin() noexcept
Return an iterator to begin traversing the UList.
Definition: UListI.H:329
void size(const label n)
Older name for setAddressableSize.
Definition: UList.H:114
A cell is defined as a list of faces with extra functionality.
Definition: cell.H:57
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
const lduMatrix & matrix() const noexcept
Definition: lduMatrix.H:233
scalarField & diag()
Definition: lduMatrix.C:192
void dot(FieldField< Field1, typename innerProduct< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
dimensionedSphericalTensor inv(const dimensionedSphericalTensor &dt)
void diag(pointPatchField< vector > &, const pointPatchField< tensor > &)