OpenFOAM logo
Open Source CFD Toolkit

BICCG.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     BICCG
00027 
00028 Description
00029 
00030 SourceFiles
00031     BICCG.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef BICCG_H
00036 #define BICCG_H
00037 
00038 #include "ICCG.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class BICCG Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 class BICCG
00050 :
00051     public ICCG
00052 {
00053 private:
00054 
00055     // Static data
00056 
00057         //- Maximum number of iterations in the solver
00058         static label maxIter_;
00059 
00060 
00061     // Private Member Functions
00062 
00063         //- Disallow default bitwise copy construct
00064         BICCG(const BICCG&);
00065 
00066         //- Disallow default bitwise assignment
00067         void operator=(const BICCG&);
00068 
00069 
00070 public:
00071 
00072     //- Runtime type information
00073 #   ifndef BICCGname
00074 #   define BICCGname "BICCG"
00075 #   endif
00076     TypeName(BICCGname);
00077 #   undef BICCGname
00078 
00079 
00080     // Constructors
00081 
00082         //- Construct from matrix and solver data stream
00083         BICCG
00084         (
00085             const word& fieldName,
00086             scalarField& psi,
00087             const lduMatrix& matrix,
00088             const scalarField& source,
00089             const FieldField<Field, scalar>& coupleBouCoeffs,
00090             const FieldField<Field, scalar>& coupleIntCoeffs,
00091             const lduCoupledInterfacePtrsList& interfaces,
00092             const direction cmpt,
00093             Istream& solverData
00094         );
00095 
00096 
00097     // Member Functions
00098 
00099         //- Solve the matrix with this solver
00100         lduMatrix::solverPerformance solve();
00101 
00102         //- Set maximum number of iterations
00103         static label setMaxIter(const label mIter)
00104         {
00105             label oldMaxIter = maxIter_;
00106             maxIter_ = mIter;
00107 
00108             return oldMaxIter;
00109         }
00110 };
00111 
00112 
00113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00114 
00115 } // End namespace Foam
00116 
00117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00118 
00119 #endif
00120 
00121 // ************************************************************************* //
For further information go to www.openfoam.org