Loading...
Searching...
No Matches
reverseRamp.C
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-------------------------------------------------------------------------------
12License
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#include "reverseRamp.H"
33// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
34
35namespace Foam
36{
37namespace Function1Types
38{
40}
41}
42
43
44// * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * * //
45
47(
48 const word& entryName,
49 const dictionary& dict,
50 const objectRegistry* obrPtr
51)
52:
53 ramp(entryName, dict),
54 minValue_(dict.getOrDefault<scalar>("minValue", Zero)),
55 interval_(dict.get<scalar>("interval")),
56 steps_(duration_/interval_)
57{}
58
59
60// ************************************************************************* //
#define makeScalarFunction1(SS)
Definition Function1.H:456
Macros for easy insertion into run-time selection tables.
ramp(const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
Construct from entry name, dictionary and optional registry.
Definition ramp.C:34
scalar duration_
Duration of the ramp function.
Definition ramp.H:111
Reverse ramp function starting from 1 and decreasing stepRamply to a min. user-specified value from s...
Definition reverseRamp.H:59
scalar steps_
Steps to reach the min. value.
Definition reverseRamp.H:77
scalar minValue_
The min value.
Definition reverseRamp.H:67
scalar interval_
Interval for reducing the base value.
Definition reverseRamp.H:72
reverseRamp(const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
Construct from entry and dictionary.
Definition reverseRamp.C:40
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition dictionary.H:133
Registry of regIOobjects.
A class for handling words, derived from Foam::string.
Definition word.H:66
Namespace for OpenFOAM.
static constexpr const zero Zero
Global zero (0).
Definition zero.H:127
dictionary dict