FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

noPreconditioner.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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::noPreconditioner
00026 
00027 Description
00028     Null preconditioner for both symmetric and asymmetric matrices.
00029 
00030 SourceFiles
00031     noPreconditioner.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef noPreconditioner_H
00036 #define noPreconditioner_H
00037 
00038 #include <OpenFOAM/lduMatrix.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class noPreconditioner Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 class noPreconditioner
00050 :
00051     public lduMatrix::preconditioner
00052 {
00053     // Private Member Functions
00054 
00055         //- Disallow default bitwise copy construct
00056         noPreconditioner(const noPreconditioner&);
00057 
00058         //- Disallow default bitwise assignment
00059         void operator=(const noPreconditioner&);
00060 
00061 
00062 public:
00063 
00064     //- Runtime type information
00065     TypeName("none");
00066 
00067 
00068     // Constructors
00069 
00070         //- Construct from matrix components and preconditioner solver controls
00071         noPreconditioner
00072         (
00073             const lduMatrix::solver&, 
00074             const dictionary& solverControlsUnused
00075         );
00076 
00077 
00078     // Destructor
00079 
00080         virtual ~noPreconditioner()
00081         {}
00082 
00083 
00084     // Member Functions
00085 
00086         //- Return wA the preconditioned form of residual rA
00087         virtual void precondition
00088         (
00089             scalarField& wA,
00090             const scalarField& rA,
00091             const direction cmpt=0
00092         ) const;
00093 
00094         //- Return wT the transpose-matrix preconditioned form of residual rT.
00095         virtual void preconditionT
00096         (
00097             scalarField& wT,
00098             const scalarField& rT,
00099             const direction cmpt=0
00100         ) const
00101         {
00102             return precondition(wT, rT, cmpt);
00103         }
00104 };
00105 
00106 
00107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00108 
00109 } // End namespace Foam
00110 
00111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00112 
00113 #endif
00114 
00115 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines