Fix tutorials: coupled/conjugateHeatFoam/conjugateCavity: fix Allrun file
[OpenFOAM-1.6-ext.git] / src / coupledMatrix / coupledLduSolver / bicgStabSolver / coupledBicgStabSolver.H
blob649e0852feef74527cc7fdd9eb7c893cf758ceea
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright held by original author
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     coupledBicgStabSolver
28 Description
29     Preconditioned Stabilised Bi-Conjugate Gradient solver
31 Author
32     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
34 SourceFiles
35     coupledBicgStabSolver.C
37 \*---------------------------------------------------------------------------*/
39 #ifndef coupledBicgStabSolver_H
40 #define coupledBicgStabSolver_H
42 #include "coupledIterativeSolver.H"
43 #include "coupledLduPrecon.H"
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 namespace Foam
50 /*---------------------------------------------------------------------------*\
51                       Class coupledBicgStabSolver Declaration
52 \*---------------------------------------------------------------------------*/
54 class coupledBicgStabSolver
56     public coupledIterativeSolver
58     // Private Data
60         // Gauss-Seidel preconditioner
61         autoPtr<coupledLduPrecon> preconPtr_;
64     // Private Member Functions
66         //- Disallow default bitwise copy construct
67         coupledBicgStabSolver(const coupledBicgStabSolver&);
69         //- Disallow default bitwise assignment
70         void operator=(const coupledBicgStabSolver&);
73 public:
75     //- Runtime type information
76     TypeName("BiCGStab");
79     // Constructors
81         //- Construct from matrix
82         coupledBicgStabSolver
83         (
84             const word& fieldName,
85             const coupledLduMatrix& matrix,
86             const PtrList<FieldField<Field, scalar> >& bouCoeffs,
87             const PtrList<FieldField<Field, scalar> >& intCoeffs,
88             const lduInterfaceFieldPtrsListList& interfaces,
89             const dictionary& solverData
90         );
93     // Destructor
95         virtual ~coupledBicgStabSolver()
96         {}
99     // Member Functions
101         //- Solve the matrix with this solver
102         virtual coupledSolverPerformance solve
103         (
104             FieldField<Field, scalar>& x,
105             const FieldField<Field, scalar>& b,
106             const direction cmpt = 0
107         ) const;
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 } // End namespace Foam
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 #endif
119 // ************************************************************************* //