ramp.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) 2017 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "ramp.H"
29 
30 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
31 
32 void Foam::Function1Types::ramp::read(const dictionary& coeffs)
33 {
34  start_ = coeffs.lookupOrDefault<scalar>("start", 0);
35  coeffs.readEntry("duration", duration_);
36 }
37 
38 
40 (
41  const word& entryName,
42  const dictionary& dict
43 )
44 :
45  Function1<scalar>(entryName)
46 {
47  read(dict);
48 }
49 
50 
51 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
52 
54 {}
55 
56 
57 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
58 
60 {
62  os << token::END_STATEMENT << nl;
63 
64  os.beginBlock(word(this->name() + "Coeffs"));
65 
66  os.writeEntry("start", start_);
67  os.writeEntry("duration", duration_);
68 
69  os.endBlock();
70 }
71 
72 
73 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::read
bool read(const char *buf, int32_t &val)
Same as readInt32.
Definition: int32.H:108
Foam::Function1Types::ramp::writeData
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: ramp.C:59
Foam::Ostream::beginBlock
virtual Ostream & beginBlock(const keyType &kw)
Write begin block group with the given name.
Definition: Ostream.C:91
Foam::Function1< scalar >
Foam::Function1Types::ramp::ramp
ramp(const word &entryName, const dictionary &dict)
Construct from entry name and dictionary.
Definition: ramp.C:40
Foam::name
word name(const complex &c)
Return string representation of complex.
Definition: complex.C:76
Foam::Function1::writeData
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Function1.C:165
Foam::token::END_STATEMENT
End entry [isseparator].
Definition: token.H:116
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::Ostream::endBlock
virtual Ostream & endBlock()
Write end block group.
Definition: Ostream.C:109
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::Function1Types::ramp::duration_
scalar duration_
Duration of the ramp function.
Definition: ramp.H:110
Foam::nl
constexpr char nl
Definition: Ostream.H:372
Foam::Function1Types::ramp::start_
scalar start_
Start-time of the ramp function.
Definition: ramp.H:107
Foam::Ostream::writeEntry
Ostream & writeEntry(const keyType &key, const T &value)
Write a keyword/value entry.
Definition: Ostream.H:219
Foam::Function1Types::ramp::~ramp
virtual ~ramp()
Destructor.
Definition: ramp.C:53
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
ramp.H