tolerances.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 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 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 public:
61 
62  // Constructors
63 
64  //- Construct from time
65  tolerances(const Time& t, const fileName& dictName);
66 
67  //- Disallow default bitwise copy construction
68  tolerances(const tolerances&) = delete;
69 
70 
71  // Member Functions
72 
73  // Access
74 
75  bool relax(const word& name) const;
76  scalar relaxationFactor(const word& name) const;
77 
78  scalar solverTolerance(const word& name) const;
79 
80  bool solverRelativeTolerances() const;
81  scalar solverRelativeTolerance(const word& name) const;
82 
83 
84  // Read
85 
86  //- Read the tolerances
87  bool read();
88 
89 
90  // Member Operators
91 
92  void operator=(const tolerances&) = delete;
93 };
94 
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #endif
103 
104 // ************************************************************************* //
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:57
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:76
const word dictName() const
Return the local dictionary name (final part of scoped name)
Definition: dictionary.H:123
const fileName & name() const
Return the dictionary name.
Definition: dictionary.H:111
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
A class for handling file names.
Definition: fileName.H:82
Selector class for solution tolerances.
Definition: tolerances.H:51
scalar solverTolerance(const word &name) const
Definition: tolerances.C:100
tolerances(const Time &t, const fileName &dictName)
Construct from time.
Definition: tolerances.C:30
bool solverRelativeTolerances() const
Definition: tolerances.C:106
bool relax(const word &name) const
Definition: tolerances.C:88
scalar relaxationFactor(const word &name) const
Definition: tolerances.C:94
scalar solverRelativeTolerance(const word &name) const
Definition: tolerances.C:112
void operator=(const tolerances &)=delete
bool read()
Read the tolerances.
Definition: tolerances.C:56
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.