reverseRampI.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) 2007-2019 PCOpt/NTUA
9  Copyright (C) 2013-2019 FOSS GP
10  Copyright (C) 2019 OpenCFD Ltd.
11 -------------------------------------------------------------------------------
12 License
13  This file is part of OpenFOAM.
14 
15  OpenFOAM is free software: you can redistribute it and/or modify it
16  under the terms of the GNU General Public License as published by
17  the Free Software Foundation, either version 3 of the License, or
18  (at your option) any later version.
19 
20  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
21  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
22  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
23  for more details.
24 
25  You should have received a copy of the GNU General Public License
26  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
27 
28 \*---------------------------------------------------------------------------*/
29 
30 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
31 
33 (
34  const scalar t
35 ) const
36 {
37  // Reverse linear ramp
38  //return min(max(scalar(1) - (t - start_)/duration_, scalar(0)), scalar(1));
39 
40  // Reverse step ramp
41  return min
42  (
43  max
44  (
45  -(floor((t - start_)/interval_))/steps_
46  *(scalar(1) - minValue_) + scalar(1),
47  minValue_
48  ),
49  scalar(1)
50  );
51 }
52 
53 // ************************************************************************* //
scalar minValue_
The min value.
Definition: reverseRamp.H:67
label max(const labelHashSet &set, label maxValue=labelMin)
Find the max value in labelHashSet, optionally limited by second argument.
Definition: hashSets.C:40
scalar start_
Start-time of the ramp function.
Definition: ramp.H:106
label min(const labelHashSet &set, label minValue=labelMax)
Find the min value in labelHashSet, optionally limited by second argument.
Definition: hashSets.C:26
scalar interval_
Interval for reducing the base value.
Definition: reverseRamp.H:72
virtual scalar value(const scalar t) const
Return value for time t.
Definition: reverseRampI.H:26
scalar steps_
Steps to reach the min. value.
Definition: reverseRamp.H:77