diagonalPreconditioner.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 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 #include "diagonalPreconditioner.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32  defineTypeNameAndDebug(diagonalPreconditioner, 0);
33 
34  lduMatrix::preconditioner::
35  addsymMatrixConstructorToTable<diagonalPreconditioner>
37 
38  lduMatrix::preconditioner::
39  addasymMatrixConstructorToTable<diagonalPreconditioner>
41 }
42 
43 
44 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
45 
47 (
48  const lduMatrix::solver& sol,
49  const dictionary&
50 )
51 :
53  rD(sol.matrix().diag().size())
54 {
55  scalar* __restrict__ rDPtr = rD.begin();
56  const scalar* __restrict__ DPtr = solver_.matrix().diag().begin();
57 
58  label nCells = rD.size();
59 
60  // Generate reciprocal diagonal
61  for (label cell=0; cell<nCells; cell++)
62  {
63  rDPtr[cell] = 1.0/DPtr[cell];
64  }
65 }
66 
67 
68 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
69 
71 (
72  scalarField& wA,
73  const scalarField& rA,
74  const direction
75 ) const
76 {
77  scalar* __restrict__ wAPtr = wA.begin();
78  const scalar* __restrict__ rAPtr = rA.begin();
79  const scalar* __restrict__ rDPtr = rD.begin();
80 
81  label nCells = wA.size();
82 
83  for (label cell=0; cell<nCells; cell++)
84  {
85  wAPtr[cell] = rDPtr[cell]*rAPtr[cell];
86  }
87 }
88 
89 
90 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
uint8_t direction
Definition: direction.H:45
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:164
const lduMatrix & matrix() const
Definition: lduMatrix.H:226
lduMatrix::preconditioner::addasymMatrixConstructorToTable< diagonalPreconditioner > adddiagonalPreconditionerAsymMatrixConstructorToTable_
Abstract base-class for lduMatrix solvers.
Definition: lduMatrix.H:93
iterator begin()
Return an iterator to begin traversing the UList.
Definition: UListI.H:216
defineTypeNameAndDebug(combustionModel, 0)
lduMatrix::preconditioner::addsymMatrixConstructorToTable< diagonalPreconditioner > adddiagonalPreconditionerSymMatrixConstructorToTable_
Abstract base-class for lduMatrix preconditioners.
Definition: lduMatrix.H:410
A cell is defined as a list of faces with extra functionality.
Definition: cell.H:57
scalarField & diag()
Definition: lduMatrix.C:186
virtual void precondition(scalarField &wA, const scalarField &rA, const direction cmpt=0) const
Return wA the preconditioned form of residual rA.
diagonalPreconditioner(const lduMatrix::solver &, const dictionary &solverControlsUnused)
Construct from matrix components and preconditioner solver controls.
Namespace for OpenFOAM.