DILUSmoother.H
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-2019 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 Class
25  Foam::DILUSmoother
26 
27 Description
28  Simplified diagonal-based incomplete LU smoother for asymmetric matrices.
29 
30 SourceFiles
31  DILUSmoother.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef DILUSmoother_H
36 #define DILUSmoother_H
37 
38 #include "lduMatrix.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class DILUSmoother Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class DILUSmoother
50 :
51  public lduMatrix::smoother
52 {
53  // Private Data
54 
55  //- The reciprocal preconditioned diagonal
56  scalarField rD_;
57 
58 
59 public:
60 
61  //- Runtime type information
62  TypeName("DILU");
63 
64 
65  // Constructors
66 
67  //- Construct from matrix components
69  (
70  const word& fieldName,
71  const lduMatrix& matrix,
75  );
76 
77 
78  // Member Functions
79 
80  //- Smooth the solution for a given number of sweeps
81  void smooth
82  (
84  const scalarField& source,
85  const direction cmpt,
86  const label nSweeps
87  ) const;
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace Foam
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 #endif
98 
99 // ************************************************************************* //
Simplified diagonal-based incomplete LU smoother for asymmetric matrices.
Definition: DILUSmoother.H:51
TypeName("DILU")
Runtime type information.
DILUSmoother(const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces)
Construct from matrix components.
Definition: DILUSmoother.C:43
void smooth(scalarField &psi, const scalarField &source, const direction cmpt, const label nSweeps) const
Smooth the solution for a given number of sweeps.
Definition: DILUSmoother.C:68
Generic field type.
Definition: FieldField.H:77
Abstract base-class for lduMatrix smoothers.
Definition: lduMatrix.H:271
const lduInterfaceFieldPtrsList & interfaces() const
Definition: lduMatrix.H:392
const FieldField< Field, scalar > & interfaceIntCoeffs() const
Definition: lduMatrix.H:387
const word & fieldName() const
Definition: lduMatrix.H:372
const lduMatrix & matrix() const
Definition: lduMatrix.H:377
const FieldField< Field, scalar > & interfaceBouCoeffs() const
Definition: lduMatrix.H:382
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
Namespace for OpenFOAM.
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
uint8_t direction
Definition: direction.H:45