src/OpenFOAM/matrices/tolerances/tolerances.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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 \*---------------------------------------------------------------------------*/
  25
  26 #include "tolerances.H"
  27
  28 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  29
  30 Foam::tolerances::tolerances(const Time& t, const fileName& dictName)
  31 :
  32     IOdictionary
  33     (
  34         IOobject
  35         (
  36             dictName,
  37             t.system(),
  38             t,
  39             IOobject::MUST_READ_IF_MODIFIED,
  40             IOobject::NO_WRITE
  41         )
  42     ),
  43     relaxationFactors_(ITstream("relaxationFactors", tokenList())()),
  44     solverTolerances_(ITstream("solverTolerances", tokenList())()),
  45     solverRelativeTolerances_
  46     (
  47         ITstream("solverRelativeTolerances", tokenList())()
  48     )
  49 {
  50     read();
  51 }
  52
  53
  54 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  55
  56 bool Foam::tolerances::read()
  57 {
  58     if (regIOobject::read())
  59     {
  60         const word toleranceSetName(lookup("toleranceSet"));
  61         const dictionary& toleranceSet(subDict(toleranceSetName));
  62
  63         if (toleranceSet.found("relaxationFactors"))
  64         {
  65             relaxationFactors_ = toleranceSet.subDict("relaxationFactors");
  66         }
  67
  68         if (toleranceSet.found("solverTolerances"))
  69         {
  70             solverTolerances_ = toleranceSet.subDict("solverTolerances");
  71         }
  72
  73         if (toleranceSet.found("solverRelativeTolerances"))
  74         {
  75             solverRelativeTolerances_ =
  76                 toleranceSet.subDict("solverRelativeTolerances");
  77         }
  78
  79         return true;
  80     }
  81     else
  82     {
  83         return false;
  84     }
  85 }
  86
  87
  88 bool Foam::tolerances::relax(const word& name) const
  89 {
  90     return relaxationFactors_.found(name);
  91 }
  92
  93
  94 Foam::scalar Foam::tolerances::relaxationFactor(const word& name) const
  95 {
  96     return readScalar(relaxationFactors_.lookup(name));
  97 }
  98
  99
 100 Foam::scalar Foam::tolerances::solverTolerance(const word& name) const
 101 {
 102     return readScalar(solverTolerances_.lookup(name));
 103 }
 104
 105
 106 bool Foam::tolerances::solverRelativeTolerances() const
 107 {
 108     return solverRelativeTolerances_.size();
 109 }
 110
 111
 112 Foam::scalar Foam::tolerances::solverRelativeTolerance(const word& name) const
 113 {
 114     return readScalar(solverRelativeTolerances_.lookup(name));
 115 }
 116
 117
 118 // ************************************************************************* //