FreeFOAM The Cross-Platform CFD Toolkit
BICCG.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::BICCG
26 
27 Description
28  Diagonal incomplete LU preconditioned BiCG solver derived from the general
29  preconditioned BiCG solver PBiCG but with the choice of preconditioner
30  pre-selected.
31 
32 Deprecated
33  This solver is present for backward-compatibility and the PBiCG solver
34  should be used instead.
35 
36 SourceFiles
37  BICCG.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef BICCG_H
42 #define BICCG_H
43 
44 #include <OpenFOAM/PBiCG.H>
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class BICCG Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class BICCG
56 :
57  public PBiCG
58 {
59  // Private Member Functions
60 
61  //- Disallow default bitwise copy construct
62  BICCG(const BICCG&);
63 
64  //- Disallow default bitwise assignment
65  void operator=(const BICCG&);
66 
67 public:
68 
69  //- Return the dictionary constructed from the components.
70  // Needed for backward compatibility
71  static dictionary solverDict
72  (
73  const scalar tol,
74  const scalar relTol
75  );
76 
77  //- Return the dictionary constructed from the old-style data-stream.
78  // Needed for backward compatibility
79  static dictionary solverDict(Istream&);
80 
81 
82  //- Runtime type information
83  TypeName("BICCG");
84 
85 
86  // Constructors
87 
88  //- Construct from matrix components and solver data stream
89  BICCG
90  (
91  const word& fieldName,
92  const lduMatrix& matrix,
96  const dictionary& solverControls
97  );
98 
99 
100  //- Construct from matrix components and tolerances
101  BICCG
102  (
103  const word& fieldName,
104  const lduMatrix& matrix,
105  const FieldField<Field, scalar>& interfaceBouCoeffs,
106  const FieldField<Field, scalar>& interfaceIntCoeffs,
107  const lduInterfaceFieldPtrsList& interfaces,
108  const scalar tolerance,
109  const scalar relTol = 0.0
110  );
111 
112  // Destructor
113 
114  virtual ~BICCG()
115  {}
116 
117 };
118 
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************ vim: set sw=4 sts=4 et: ************************ //