The open source CFD toolbox
tableBounds.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2017 OpenCFD Ltd.
9-------------------------------------------------------------------------------
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Namespace
27 Foam::bounds
28
29Description
30 Namespace for bounding specifications.
31 At the moment, mostly for tables.
32
33SourceFiles
34 tableBounds.C
35
36\*---------------------------------------------------------------------------*/
37
38#ifndef tableBounds_H
39#define tableBounds_H
40
41#include "Enum.H"
42
43// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45namespace Foam
46{
47namespace bounds
48{
49
50 // Enumerations
51
52 //- Enumeration for handling out-of-bound values
53 enum class normalBounding
54 {
55 ERROR,
56 WARN,
57 CLAMP
58 };
59
60 //- Enumeration for handling out-of-bound values that are repeatable
62 {
63 ERROR,
64 WARN,
65 CLAMP,
66 REPEAT
67 };
68
69
70 //- Strings corresponding to the normalBounding
72
73 //- Strings corresponding to the repeatableBounding
75
76
77// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
78
79} // End namespace bounds
80} // End namespace Foam
81
82// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83
84#endif
85
86// ************************************************************************* //
Enum is a wrapper around a list of names/values that represent particular enumeration (or int) values...
Definition: Enum.H:61
repeatableBounding
Enumeration for handling out-of-bound values that are repeatable.
Definition: tableBounds.H:62
@ REPEAT
Treat as a repeating list.
const Foam::Enum< normalBounding > normalBoundingNames
Strings corresponding to the normalBounding.
const Foam::Enum< repeatableBounding > repeatableBoundingNames
Strings corresponding to the repeatableBounding.
normalBounding
Enumeration for handling out-of-bound values.
Definition: tableBounds.H:54
@ WARN
Issue warning and clamp value (this is a good default)
@ ERROR
Exit with a FatalError.
@ CLAMP
Clamp value to the start/end value.
Namespace for OpenFOAM.