FDICPreconditioner.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 "FDICPreconditioner.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32  defineTypeNameAndDebug(FDICPreconditioner, 0);
33 
34  lduMatrix::preconditioner::
35  addsymMatrixConstructorToTable<FDICPreconditioner>
37 }
38 
39 
40 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41 
43 (
44  const lduMatrix::solver& sol,
45  const dictionary&
46 )
47 :
49  rD_(sol.matrix().diag()),
50  rDuUpper_(sol.matrix().upper().size()),
51  rDlUpper_(sol.matrix().upper().size())
52 {
53  scalar* __restrict__ rDPtr = rD_.begin();
54  scalar* __restrict__ rDuUpperPtr = rDuUpper_.begin();
55  scalar* __restrict__ rDlUpperPtr = rDlUpper_.begin();
56 
57  const label* const __restrict__ uPtr =
58  solver_.matrix().lduAddr().upperAddr().begin();
59  const label* const __restrict__ lPtr =
60  solver_.matrix().lduAddr().lowerAddr().begin();
61  const scalar* const __restrict__ upperPtr =
62  solver_.matrix().upper().begin();
63 
64  label nCells = rD_.size();
65  label nFaces = solver_.matrix().upper().size();
66 
67  for (label face=0; face<nFaces; face++)
68  {
69  rDPtr[uPtr[face]] -= sqr(upperPtr[face])/rDPtr[lPtr[face]];
70  }
71 
72  // Generate reciprocal FDIC
73  for (label cell=0; cell<nCells; cell++)
74  {
75  rDPtr[cell] = 1.0/rDPtr[cell];
76  }
77 
78  for (label face=0; face<nFaces; face++)
79  {
80  rDuUpperPtr[face] = rDPtr[uPtr[face]]*upperPtr[face];
81  rDlUpperPtr[face] = rDPtr[lPtr[face]]*upperPtr[face];
82  }
83 }
84 
85 
86 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
87 
89 (
90  scalarField& wA,
91  const scalarField& rA,
92  const direction
93 ) const
94 {
95  scalar* __restrict__ wAPtr = wA.begin();
96  const scalar* __restrict__ rAPtr = rA.begin();
97  const scalar* __restrict__ rDPtr = rD_.begin();
98 
99  const label* const __restrict__ uPtr =
100  solver_.matrix().lduAddr().upperAddr().begin();
101  const label* const __restrict__ lPtr =
102  solver_.matrix().lduAddr().lowerAddr().begin();
103 
104  const scalar* const __restrict__ rDuUpperPtr = rDuUpper_.begin();
105  const scalar* const __restrict__ rDlUpperPtr = rDlUpper_.begin();
106 
107  label nCells = wA.size();
108  label nFaces = solver_.matrix().upper().size();
109  label nFacesM1 = nFaces - 1;
110 
111  for (label cell=0; cell<nCells; cell++)
112  {
113  wAPtr[cell] = rDPtr[cell]*rAPtr[cell];
114  }
115 
116  for (label face=0; face<nFaces; face++)
117  {
118  wAPtr[uPtr[face]] -= rDuUpperPtr[face]*wAPtr[lPtr[face]];
119  }
120 
121  for (label face=nFacesM1; face>=0; face--)
122  {
123  wAPtr[lPtr[face]] -= rDlUpperPtr[face]*wAPtr[uPtr[face]];
124  }
125 }
126 
127 
128 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A face is a list of labels corresponding to mesh vertices.
Definition: face.H:75
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
dimensionedSymmTensor sqr(const dimensionedVector &dv)
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
scalarField & upper()
Definition: lduMatrix.C:197
FDICPreconditioner(const lduMatrix::solver &, const dictionary &solverControlsUnused)
Construct from matrix components and preconditioner solver controls.
Abstract base-class for lduMatrix solvers.
Definition: lduMatrix.H:93
iterator begin()
Return an iterator to begin traversing the UList.
Definition: UListI.H:216
virtual void precondition(scalarField &wA, const scalarField &rA, const direction cmpt=0) const
Return wA the preconditioned form of residual rA.
defineTypeNameAndDebug(combustionModel, 0)
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:56
scalarField & diag()
Definition: lduMatrix.C:186
lduMatrix::preconditioner::addsymMatrixConstructorToTable< FDICPreconditioner > addFDICPreconditionerSymMatrixConstructorToTable_
Namespace for OpenFOAM.