DICSmoother.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 "DICSmoother.H"
27 #include "DICPreconditioner.H"
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
34 
35  lduMatrix::smoother::addsymMatrixConstructorToTable<DICSmoother>
37 }
38 
39 
40 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41 
43 (
44  const word& fieldName,
45  const lduMatrix& matrix,
46  const FieldField<Field, scalar>& interfaceBouCoeffs,
47  const FieldField<Field, scalar>& interfaceIntCoeffs,
48  const lduInterfaceFieldPtrsList& interfaces
49 )
50 :
51  lduMatrix::smoother
52  (
53  fieldName,
54  matrix,
55  interfaceBouCoeffs,
56  interfaceIntCoeffs,
57  interfaces
58  ),
59  rD_(matrix_.diag())
60 {
62 }
63 
64 
65 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
66 
68 (
70  const scalarField& source,
71  const direction cmpt,
72  const label nSweeps
73 ) const
74 {
75  const scalar* const __restrict__ rDPtr = rD_.begin();
76  const scalar* const __restrict__ upperPtr = matrix_.upper().begin();
77  const label* const __restrict__ uPtr =
78  matrix_.lduAddr().upperAddr().begin();
79  const label* const __restrict__ lPtr =
80  matrix_.lduAddr().lowerAddr().begin();
81 
82  // Temporary storage for the residual
83  scalarField rA(rD_.size());
84  scalar* __restrict__ rAPtr = rA.begin();
85 
86  for (label sweep=0; sweep<nSweeps; sweep++)
87  {
88  matrix_.residual
89  (
90  rA,
91  psi,
92  source,
93  interfaceBouCoeffs_,
94  interfaces_,
95  cmpt
96  );
97 
98  rA *= rD_;
99 
100  label nFaces = matrix_.upper().size();
101  for (label facei=0; facei<nFaces; facei++)
102  {
103  label u = uPtr[facei];
104  rAPtr[u] -= rDPtr[u]*upperPtr[facei]*rAPtr[lPtr[facei]];
105  }
106 
107  label nFacesM1 = nFaces - 1;
108  for (label facei=nFacesM1; facei>=0; facei--)
109  {
110  label l = lPtr[facei];
111  rAPtr[l] -= rDPtr[l]*upperPtr[facei]*rAPtr[uPtr[facei]];
112  }
113 
114  psi += rA;
115  }
116 }
117 
118 
119 // ************************************************************************* //
static void calcReciprocalD(scalarField &rD, const lduMatrix &matrix)
Calculate the reciprocal of the preconditioned diagonal.
Simplified diagonal-based incomplete Cholesky smoother for symmetric matrices.
Definition: DICSmoother.H:55
void smooth(scalarField &psi, const scalarField &source, const direction cmpt, const label nSweeps) const
Smooth the solution for a given number of sweeps.
Definition: DICSmoother.C:68
DICSmoother(const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces)
Construct from matrix components.
Definition: DICSmoother.C:43
Generic field type.
Definition: FieldField.H:77
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:164
iterator begin()
Return an iterator to begin traversing the UList.
Definition: UListI.H:216
const lduMatrix & matrix_
Definition: lduMatrix.H:277
lduMatrix is a general matrix class in which the coefficients are stored as three arrays,...
Definition: lduMatrix.H:80
A class for handling words, derived from string.
Definition: word.H:62
const volScalarField & psi
void sweep(volScalarField &field, const volScalarField &alpha, const label nLayers, const scalar alphaDiff=0.2)
Definition: fvcSmooth.C:240
Namespace for OpenFOAM.
lduMatrix::smoother::addsymMatrixConstructorToTable< DICSmoother > addDICSmootherSymMatrixConstructorToTable_
Definition: DICSmoother.C:36
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
void diag(pointPatchField< vector > &, const pointPatchField< tensor > &)
defineTypeNameAndDebug(combustionModel, 0)
uint8_t direction
Definition: direction.H:45