DICSmoother.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-2020 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::DICSmoother
26 
27 Description
28  Simplified diagonal-based incomplete Cholesky smoother for symmetric
29  matrices.
30 
31  To improve efficiency, the residual is evaluated after every nSweeps
32  sweeps.
33 
34 SourceFiles
35  DICSmoother.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef DICSmoother_H
40 #define DICSmoother_H
41 
42 #include "lduMatrix.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class DICSmoother Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class DICSmoother
54 :
55  public lduMatrix::smoother
56 {
57  // Private Data
58 
59  //- The reciprocal preconditioned diagonal
60  scalarField rD_;
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("DIC");
67 
68 
69  // Constructors
70 
71  //- Construct from matrix components
73  (
74  const word& fieldName,
75  const lduMatrix& matrix,
79  );
80 
81 
82  // Member Functions
83 
84  //- Smooth the solution for a given number of sweeps
85  void smooth
86  (
88  const scalarField& source,
89  const direction cmpt,
90  const label nSweeps
91  ) const;
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
const FieldField< Field, scalar > & interfaceIntCoeffs() const
Definition: lduMatrix.H:387
const word & fieldName() const
Definition: lduMatrix.H:372
uint8_t direction
Definition: direction.H:45
TypeName("DIC")
Runtime type information.
Simplified diagonal-based incomplete Cholesky smoother for symmetric matrices.
Definition: DICSmoother.H:52
const lduMatrix & matrix() const
Definition: lduMatrix.H:377
const FieldField< Field, scalar > & interfaceBouCoeffs() const
Definition: lduMatrix.H:382
Generic field type.
Definition: FieldField.H:51
Abstract base-class for lduMatrix smoothers.
Definition: lduMatrix.H:270
A class for handling words, derived from string.
Definition: word.H:59
const volScalarField & psi
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
lduMatrix is a general matrix class in which the coefficients are stored as three arrays...
Definition: lduMatrix.H:79
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
const lduInterfaceFieldPtrsList & interfaces() const
Definition: lduMatrix.H:392
Namespace for OpenFOAM.