src/foam/matrices/tolerances/tolerances.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "tolerances.H"
  27
  28 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  29
  30 namespace Foam
  31 {
  32
  33 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  34
  35 tolerances::tolerances(const Time& t, const fileName& dictName)
  36 :
  37     IOdictionary
  38     (
  39         IOobject
  40         (
  41             dictName,
  42             t.system(),
  43             t,
  44             IOobject::MUST_READ,
  45             IOobject::NO_WRITE
  46         )
  47     ),
  48     relaxationFactors_(ITstream("relaxationFactors", tokenList())()),
  49     solverTolerances_(ITstream("solverTolerances", tokenList())()),
  50     solverRelativeTolerances_
  51     (
  52         ITstream("solverRelativeTolerances", tokenList())()
  53     )
  54 {
  55     read();
  56 }
  57
  58
  59 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  60
  61 bool tolerances::read()
  62 {
  63     if (regIOobject::read())
  64     {
  65         word toleranceSetName(lookup("toleranceSet"));
  66         const dictionary& toleranceSet(subDict(toleranceSetName));
  67
  68         if (toleranceSet.found("relaxationFactors"))
  69         {
  70             relaxationFactors_ = toleranceSet.subDict("relaxationFactors");
  71         }
  72
  73         if (toleranceSet.found("solverTolerances"))
  74         {
  75             solverTolerances_ = toleranceSet.subDict("solverTolerances");
  76         }
  77
  78         if (toleranceSet.found("solverRelativeTolerances"))
  79         {
  80             solverRelativeTolerances_ =
  81                 toleranceSet.subDict("solverRelativeTolerances");
  82         }
  83
  84         return true;
  85     }
  86     else
  87     {
  88         return false;
  89     }
  90 }
  91
  92
  93 bool tolerances::relax(const word& name) const
  94 {
  95     return relaxationFactors_.found(name);
  96 }
  97
  98 scalar tolerances::relaxationFactor(const word& name) const
  99 {
 100     return readScalar(relaxationFactors_.lookup(name));
 101 }
 102
 103 scalar tolerances::solverTolerance(const word& name) const
 104 {
 105     return readScalar(solverTolerances_.lookup(name));
 106 }
 107
 108 bool tolerances::solverRelativeTolerances() const
 109 {
 110     return solverRelativeTolerances_.size();
 111 }
 112
 113 scalar tolerances::solverRelativeTolerance(const word& name) const
 114 {
 115     return readScalar(solverRelativeTolerances_.lookup(name));
 116 }
 117
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 } // End namespace Foam
 122
 123 // ************************************************************************* //