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-2009 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::tolerances
  27
  28 Description
  29     Selector class for solution tolerances.
  30
  31 SourceFiles
  32     tolerances.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef tolerances_H
  37 #define tolerances_H
  38
  39 #include "IOdictionary.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class tolerances Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class tolerances
  51 :
  52     public IOdictionary
  53 {
  54     // Private data
  55
  56         dictionary relaxationFactors_;
  57         dictionary solverTolerances_;
  58         dictionary solverRelativeTolerances_;
  59
  60
  61     // Private Member Functions
  62
  63         //- Disallow default bitwise copy construct and assignment
  64         tolerances(const tolerances&);
  65         void operator=(const tolerances&);
  66
  67
  68 public:
  69
  70     // Constructors
  71
  72         //- Construct from time
  73         tolerances(const Time& t, const fileName& dictName);
  74
  75
  76     // Member Functions
  77
  78         // Access
  79
  80             bool relax(const word& name) const;
  81             scalar relaxationFactor(const word& name) const;
  82
  83             scalar solverTolerance(const word& name) const;
  84
  85             bool solverRelativeTolerances() const;
  86             scalar solverRelativeTolerance(const word& name) const;
  87
  88
  89         // Read
  90
  91             //- Read the tolerances
  92             bool read();
  93 };
  94
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 } // End namespace Foam
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 #endif
 103
 104 // ************************************************************************* //