FreeFOAM The Cross-Platform CFD Toolkit
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) 1991-2010 OpenCFD Ltd.
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 <OpenFOAM/lduMatrix.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class noPreconditioner Declaration
47 \*---------------------------------------------------------------------------*/
48 
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 
81  {}
82 
83 
84  // Member Functions
85 
86  //- Return wA the preconditioned form of residual rA
87  virtual void precondition
88  (
89  scalarField& wA,
90  const scalarField& rA,
91  const direction cmpt=0
92  ) const;
93 
94  //- Return wT the transpose-matrix preconditioned form of residual rT.
95  virtual void preconditionT
96  (
97  scalarField& wT,
98  const scalarField& rT,
99  const direction cmpt=0
100  ) const
101  {
102  return precondition(wT, rT, cmpt);
103  }
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************ vim: set sw=4 sts=4 et: ************************ //