noPreconditioner.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011 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  // Private Member Functions
54 
55  //- Disallow default bitwise copy construct
57 
58  //- Disallow default bitwise assignment
59  void operator=(const noPreconditioner&);
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("none");
66 
67 
68  // Constructors
69 
70  //- Construct from matrix components and preconditioner solver controls
72  (
73  const lduMatrix::solver&,
74  const dictionary& solverControlsUnused
75  );
76 
77 
78  //- Destructor
79  virtual ~noPreconditioner()
80  {}
81 
82 
83  // Member Functions
84 
85  //- Return wA the preconditioned form of residual rA
86  virtual void precondition
87  (
88  scalarField& wA,
89  const scalarField& rA,
90  const direction cmpt=0
91  ) const;
92 
93  //- Return wT the transpose-matrix preconditioned form of residual rT.
94  virtual void preconditionT
95  (
96  scalarField& wT,
97  const scalarField& rT,
98  const direction cmpt=0
99  ) const
100  {
101  return precondition(wT, rT, cmpt);
102  }
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
uint8_t direction
Definition: direction.H:45
TypeName("none")
Runtime type information.
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
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.