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 -------------------------------------------------------------------------------
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 #include "reverseRamp.H"
32 
33 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 namespace Function1Types
38 {
39  makeScalarFunction1(reverseRamp);
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 // ************************************************************************* //
List< ReturnType > get(const UPtrList< T > &list, const AccessOp &aop)
List of values generated by applying the access operation to each list item.
dictionary dict
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:129
Macros for easy insertion into run-time selection tables.
A class for handling words, derived from Foam::string.
Definition: word.H:63
makeScalarFunction1(halfCosineRamp)
Registry of regIOobjects.
Namespace for OpenFOAM.
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:127