OpenFOAM logo
Open Source CFD Toolkit

tolerances.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     tolerances
00027 
00028 Description
00029     Selector class for solution tolerances.
00030 
00031 SourceFiles
00032     tolerances.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef tolerances_H
00037 #define tolerances_H
00038 
00039 #include "IOdictionary.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                            Class tolerances Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class tolerances
00051 :
00052     public IOdictionary
00053 {
00054     // Private data
00055 
00056         dictionary relaxationFactors_;
00057         dictionary solverTolerances_;
00058         dictionary solverRelativeTolerances_;
00059 
00060 
00061     // Private Member Functions
00062 
00063         //- Disallow default bitwise copy construct and assignment
00064         tolerances(const tolerances&);
00065         void operator=(const tolerances&);
00066 
00067 
00068 public:
00069 
00070     // Constructors
00071 
00072         //- Construct from time
00073         tolerances(const Time& t, const fileName& dictName);
00074 
00075 
00076     // Member Functions
00077 
00078         // Access
00079 
00080             bool relax(const word& name) const;
00081             scalar relaxationFactor(const word& name) const;
00082 
00083             scalar solverTolerance(const word& name) const;
00084 
00085             bool solverRelativeTolerances() const;
00086             scalar solverRelativeTolerance(const word& name) const;
00087 
00088 
00089         // Read
00090 
00091             //- Read the tolerances
00092             bool read();
00093 };
00094 
00095 
00096 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00097 
00098 } // End namespace Foam
00099 
00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00101 
00102 #endif
00103 
00104 // ************************************************************************* //
For further information go to www.openfoam.org