OpenFOAM
11
The OpenFOAM Foundation
tableBase.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) 2019-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::tableBase
26
27
SourceFiles
28
tableBase.C
29
30
\*---------------------------------------------------------------------------*/
31
32
#ifndef tableBase_H
33
#define tableBase_H
34
35
#include "
NamedEnum.H
"
36
37
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38
39
namespace
Foam
40
{
41
namespace
Function1s
42
{
43
44
/*---------------------------------------------------------------------------*\
45
Class tableBase Declaration
46
\*---------------------------------------------------------------------------*/
47
48
class
tableBase
49
{
50
public
:
51
52
// Public data types
53
54
//- Enumeration for handling out-of-bound values
55
enum class
boundsHandling
56
{
57
error
,
// Exit with a FatalError
58
warn
,
// Issue warning and clamp value (default)
59
clamp
,
// Clamp value to the start/end value
60
repeat
// Treat as a repeating list
61
};
62
63
//- Enumeration names for handling out-of-bound values
64
static
const
NamedEnum<boundsHandling, 4>
boundsHandlingNames_
;
65
66
67
// Constructors
68
69
//- Construct null
70
tableBase
()
71
{}
72
};
73
74
75
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
76
77
}
// namespace Function1s
78
}
// End namespace Foam
79
80
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81
82
#endif
83
84
// ************************************************************************* //
NamedEnum.H
Foam::Function1s::tableBase
Definition:
tableBase.H:48
Foam::Function1s::tableBase::boundsHandlingNames_
static const NamedEnum< boundsHandling, 4 > boundsHandlingNames_
Enumeration names for handling out-of-bound values.
Definition:
tableBase.H:63
Foam::Function1s::tableBase::boundsHandling
boundsHandling
Enumeration for handling out-of-bound values.
Definition:
tableBase.H:55
Foam::Function1s::tableBase::boundsHandling::warn
@ warn
Foam::Function1s::tableBase::boundsHandling::repeat
@ repeat
Foam::Function1s::tableBase::boundsHandling::clamp
@ clamp
Foam::Function1s::tableBase::boundsHandling::error
@ error
Foam::Function1s::tableBase::tableBase
tableBase()
Construct null.
Definition:
tableBase.H:69
Foam::NamedEnum< boundsHandling, 4 >
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.H:214
src
OpenFOAM
primitives
functions
Function1
Table
tableBase.H
Generated by
1.9.1