src/OpenFOAM/matrices/tolerances/tolerances.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  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.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::tolerances
  26
  27 Description
  28     Selector class for solution tolerances.
  29
  30 SourceFiles
  31     tolerances.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef tolerances_H
  36 #define tolerances_H
  37
  38 #include "IOdictionary.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class tolerances Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class tolerances
  50 :
  51     public IOdictionary
  52 {
  53     // Private data
  54
  55         dictionary relaxationFactors_;
  56         dictionary solverTolerances_;
  57         dictionary solverRelativeTolerances_;
  58
  59
  60     // Private Member Functions
  61
  62         //- Disallow default bitwise copy construct and assignment
  63         tolerances(const tolerances&);
  64         void operator=(const tolerances&);
  65
  66
  67 public:
  68
  69     // Constructors
  70
  71         //- Construct from time
  72         tolerances(const Time& t, const fileName& dictName);
  73
  74
  75     // Member Functions
  76
  77         // Access
  78
  79             bool relax(const word& name) const;
  80             scalar relaxationFactor(const word& name) const;
  81
  82             scalar solverTolerance(const word& name) const;
  83
  84             bool solverRelativeTolerances() const;
  85             scalar solverRelativeTolerance(const word& name) const;
  86
  87
  88         // Read
  89
  90             //- Read the tolerances
  91             bool read();
  92 };
  93
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 } // End namespace Foam
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 #endif
 102
 103 // ************************************************************************* //