tolerances.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2020 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::tolerances
 
Description
    Selector class for solution tolerances.
 
SourceFiles
    tolerances.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef tolerances_H
#define tolerances_H
 
#include "IOdictionary.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                         Class tolerances Declaration
\*---------------------------------------------------------------------------*/
 
class tolerances
:
    public IOdictionary
{
    // Private Data
 
        dictionary relaxationFactors_;
        dictionary solverTolerances_;
        dictionary solverRelativeTolerances_;
 
 
public:
 
    // Constructors
 
        //- Construct from time
        tolerances(const Time& t, const fileName& dictName);
 
        //- Disallow default bitwise copy construction
        tolerances(const tolerances&) = delete;
 
 
    // Member Functions
 
        // Access
 
            bool relax(const word& name) const;
            scalar relaxationFactor(const word& name) const;
 
            scalar solverTolerance(const word& name) const;
 
            bool solverRelativeTolerances() const;
            scalar solverRelativeTolerance(const word& name) const;
 
 
        // Read
 
            //- Read the tolerances
            bool read();
 
 
    // Member Operators
 
        void operator=(const tolerances&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //