noSmoother.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) 2026 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::noSmoother
26 
27 Description
28  A lduMatrix::smoother that does nothing. Not on the selection table. Only
29  used by GAMG in the event that the coarsest mesh is a single cell.
30 
31 SourceFiles
32  noSmoother.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef noSmoother_H
37 #define noSmoother_H
38 
39 #include "lduMatrix.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class noSmoother Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class noSmoother
51 :
52  public lduMatrix::smoother
53 {
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("no");
59 
60 
61  // Constructors
62 
63  //- Construct from components
65  (
66  const word& fieldName,
67  const lduMatrix& matrix,
71  );
72 
73 
74  // Member Functions
75 
76  //- Smooth the solution for a given number of sweeps
77  virtual void smooth
78  (
80  const scalarField& Source,
81  const direction cmpt,
82  const label nSweeps
83  ) const;
84 };
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 } // End namespace Foam
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 #endif
94 
95 // ************************************************************************* //
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 lduMatrix::smoother that does nothing. Not on the selection table. Only used by GAMG in the event t...
Definition: noSmoother.H:52
noSmoother(const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces)
Construct from components.
Definition: noSmoother.C:39
virtual void smooth(scalarField &psi, const scalarField &Source, const direction cmpt, const label nSweeps) const
Smooth the solution for a given number of sweeps.
Definition: noSmoother.C:61
TypeName("no")
Runtime type information.
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