noPreconditioner.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::noPreconditioner
26 
27 Description
28  Null preconditioner for both symmetric and asymmetric matrices.
29 
30 SourceFiles
31  noPreconditioner.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef noPreconditioner_H
36 #define noPreconditioner_H
37 
38 #include "lduMatrix.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class noPreconditioner Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class noPreconditioner
50 :
52 {
53 
54 public:
55 
56  //- Runtime type information
57  TypeName("none");
58 
59 
60  // Constructors
61 
62  //- Construct from matrix components and preconditioner solver controls
64  (
65  const lduMatrix::solver&,
66  const dictionary& solverControlsUnused
67  );
68 
69  //- Disallow default bitwise copy construction
70  noPreconditioner(const noPreconditioner&) = delete;
71 
72 
73  //- Destructor
74  virtual ~noPreconditioner()
75  {}
76 
77 
78  // Member Functions
79 
80  //- Return wA the preconditioned form of residual rA
81  virtual void precondition
82  (
83  scalarField& wA,
84  const scalarField& rA,
85  const direction cmpt=0
86  ) const;
87 
88  //- Return wT the transpose-matrix preconditioned form of residual rT.
89  virtual void preconditionT
90  (
91  scalarField& wT,
92  const scalarField& rT,
93  const direction cmpt=0
94  ) const
95  {
96  return precondition(wT, rT, cmpt);
97  }
98 
99 
100  // Member Operators
101 
102  //- Disallow default bitwise assignment
103  void operator=(const noPreconditioner&) = delete;
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
uint8_t direction
Definition: direction.H:45
TypeName("none")
Runtime type information.
noPreconditioner(const lduMatrix::solver &, const dictionary &solverControlsUnused)
Construct from matrix components and preconditioner solver controls.
virtual void precondition(scalarField &wA, const scalarField &rA, const direction cmpt=0) const
Return wA the preconditioned form of residual rA.
Abstract base-class for lduMatrix solvers.
Definition: lduMatrix.H:93
void operator=(const noPreconditioner &)=delete
Disallow default bitwise assignment.
virtual ~noPreconditioner()
Destructor.
Abstract base-class for lduMatrix preconditioners.
Definition: lduMatrix.H:410
virtual void preconditionT(scalarField &wT, const scalarField &rT, const direction cmpt=0) const
Return wT the transpose-matrix preconditioned form of residual rT.
Null preconditioner for both symmetric and asymmetric matrices.
Namespace for OpenFOAM.