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