InputValueMapperI.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) 2020-2021 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
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
26\*---------------------------------------------------------------------------*/
27
28#include "InputValueMapper.H"
29
30// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
31
32template<class Type>
34(
35 const scalar t
36) const
37{
38 switch (mappingMode_)
39 {
40 case mappingMode::NONE:
41 {
42 return value_->value(t);;
43 }
44 case mappingMode::FUNCTION1:
45 {
46 return value_->value(mappingValuePtr_->value(t));
47 }
48 case mappingMode::MINMAX:
49 {
50 scalar tlim = min(max(t, min_), max_);
51
52 return value_->value(tlim);
53 }
54 default:
55 {
57 << "Unhandled enumeration " << mappingModeNames_[mappingMode_]
58 << ". Available options are: " << mappingModeNames_.sortedToc()
59 << abort(FatalError);
60 }
61 }
62
64}
65
66
67template<class Type>
69(
70 const scalar x1,
71 const scalar x2
72) const
73{
74 switch (mappingMode_)
75 {
76 case mappingMode::NONE:
77 {
78 return value_->integrate(x1, x2);
79 }
80 case mappingMode::FUNCTION1:
81 {
82 scalar x1Dash = mappingValuePtr_->value(x1);
83 scalar x2Dash = mappingValuePtr_->value(x2);
84
85 return value_->integrate(x1Dash, x2Dash);
86 }
87 case mappingMode::MINMAX:
88 {
89 scalar xlim0 = min(max(x1, min_), max_);
90 scalar xlim1 = min(max(x2, min_), max_);
91
92 Type intValue = value_->integrate(xlim0, xlim1);
93
94 if (x1 < min_)
95 {
96 intValue += (min(min_, x2) - x1)*this->value(min_);
97 }
98
99 if (x2 > max_)
100 {
101 intValue += (x2 - max(max_, x1))*this->value(max_);
102 }
103
104 return intValue;
105 }
106 default:
107 {
109 << "Unhandled enumeration " << mappingModeNames_[mappingMode_]
110 << ". Available options are: " << mappingModeNames_.sortedToc()
111 << abort(FatalError);
112 }
113 }
114
115 return pTraits<Type>::zero;
116}
117
118
119// ************************************************************************* //
Y[inertIndex] max(0.0)
Function1 wrapper that maps the input value prior to it being used by another Function1.
virtual Type value(const scalar t) const
Return value for time t.
virtual Type integrate(const scalar x1, const scalar x2) const
Integrate between two (scalar) values.
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453
label min(const labelHashSet &set, label minValue=labelMax)
Find the min value in labelHashSet, optionally limited by second argument.
Definition: hashSets.C:33
errorManip< error > abort(error &err)
Definition: errorManip.H:144
error FatalError
A non-counting (dummy) refCount.
Definition: refCount.H:59