All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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-2019 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& coeffs)
32 {
33  start_ = coeffs.lookupOrDefault<scalar>("start", 0);
34  duration_ = coeffs.lookup<scalar>("duration");
35 }
36 
37 
38 template <class Function1Type>
40 (
41  const word& entryName,
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 {
64  os << token::END_STATEMENT << nl;
65  os << indent << word(this->name() + "Coeffs") << nl;
66  os << indent << token::BEGIN_BLOCK << incrIndent << nl;
67  writeEntry(os, "start", start_);
68  writeEntry(os, "duration", duration_);
69  os << decrIndent << indent << token::END_BLOCK << endl;
70 }
71 
72 
73 // ************************************************************************* //
Ostream & indent(Ostream &os)
Indent stream.
Definition: Ostream.H:221
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:158
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
void read(Istream &, label &, const dictionary &)
In-place read with dictionary lookup.
A class for handling words, derived from string.
Definition: word.H:59
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
static const char nl
Definition: Ostream.H:260
const bool writeData(readBool(pdfDictionary.lookup("writeData")))
Ostream & decrIndent(Ostream &os)
Decrement the indent level.
Definition: Ostream.H:235
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
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Ramp.C:61
Ramp(const word &entryName, const dictionary &dict)
Construct from entry name and dictionary.
Definition: Ramp.C:40
Ostream & incrIndent(Ostream &os)
Increment the indent level.
Definition: Ostream.H:228
Ramp function base class for the set of scalar functions starting from 0 and increasing monotonically...
Definition: Ramp.H:97