Ramp.C
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) 2017-2021 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 \*---------------------------------------------------------------------------*/
25 
26 #include "Ramp.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Function1Type>
31 void Foam::Function1s::Ramp<Function1Type>::read(const dictionary& dict)
32 {
33  start_ = dict.lookupOrDefault<scalar>("start", 0);
34  duration_ = dict.lookup<scalar>("duration");
35 }
36 
37 
38 template<class Function1Type>
40 (
41  const word& name,
42  const dictionary& dict
43 )
44 :
46 {
47  read(dict);
48 }
49 
50 
51 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
52 
53 template<class Function1Type>
55 {}
56 
57 
58 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
59 
60 template<class Function1Type>
62 {
63  writeEntry(os, "start", start_);
64  writeEntry(os, "duration", duration_);
65 }
66 
67 
68 // ************************************************************************* //
virtual ~Ramp()
Destructor.
Definition: Ramp.C:54
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual void write(Ostream &os) const
Write data to dictionary stream.
Definition: Ramp.C:61
void read(Istream &, label &, const dictionary &)
In-place read with dictionary lookup.
A class for handling words, derived from string.
Definition: word.H:59
Ramp(const word &name, const dictionary &dict)
Construct from name and dictionary.
Definition: Ramp.C:40
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
Ramp function base class for the set of scalar functions starting from 0 and increasing monotonically...
Definition: Ramp.H:116