symGaussSeidelSmoother.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) 2012-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::symGaussSeidelSmoother
26 
27 Description
28  A lduMatrix::smoother for symmetric Gauss-Seidel
29 
30 SourceFiles
31  symGaussSeidelSmoother.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef symGaussSeidelSmoother_H
36 #define symGaussSeidelSmoother_H
37 
38 #include "lduMatrix.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class symGaussSeidelSmoother Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
51  public lduMatrix::smoother
52 {
53 
54 public:
55 
56  //- Runtime type information
57  TypeName("symGaussSeidel");
58 
59 
60  // Constructors
61 
62  //- Construct from components
64  (
65  const word& fieldName,
66  const lduMatrix& matrix,
70  );
71 
72 
73  // Member Functions
74 
75  //- Smooth for the given number of sweeps
76  static void smooth
77  (
78  const word& fieldName,
80  const lduMatrix& matrix,
81  const scalarField& source,
82  const FieldField<Field, scalar>& interfaceBouCoeffs,
83  const lduInterfaceFieldPtrsList& interfaces,
84  const direction cmpt,
85  const label nSweeps
86  );
87 
88 
89  //- Smooth the solution for a given number of sweeps
90  virtual void smooth
91  (
92  scalarField& psi,
93  const scalarField& Source,
94  const direction cmpt,
95  const label nSweeps
96  ) const;
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace Foam
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
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
static void smooth(const word &fieldName, scalarField &psi, const lduMatrix &matrix, const scalarField &source, const FieldField< Field, scalar > &interfaceBouCoeffs, const lduInterfaceFieldPtrsList &interfaces, const direction cmpt, const label nSweeps)
Smooth for the given number of sweeps.
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 lduMatrix::smoother for symmetric Gauss-Seidel.
A class for handling words, derived from string.
Definition: word.H:59
const volScalarField & psi
lduMatrix is a general matrix class in which the coefficients are stored as three arrays...
Definition: lduMatrix.H:79
const lduInterfaceFieldPtrsList & interfaces() const
Definition: lduMatrix.H:392
symGaussSeidelSmoother(const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces)
Construct from components.
TypeName("symGaussSeidel")
Runtime type information.
Namespace for OpenFOAM.