The open source CFD toolbox
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  Copyright (C) 2020 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
12  This file is part of OpenFOAM.
13
14  OpenFOAM is free software: you can redistribute it and/or modify it
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27 \*---------------------------------------------------------------------------*/
28
29 #include "ramp.H"
30
31 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32
34 {
35  start_ = coeffs.getOrDefault<scalar>("start", 0);
37 }
38
39
41 (
42  const word& entryName,
43  const dictionary& dict
44 )
45 :
46  Function1<scalar>(entryName, dict)
47 {
49 }
50
51
52 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
53
55 {
56  os.writeEntry("start", start_);
57  os.writeEntry("duration", duration_);
58 }
59
60
62 {
63  start_ = t.timeToUserTime(start_);
64  duration_ = t.timeToUserTime(duration_);
65 }
66
67
69 {
71  os << token::END_STATEMENT << nl;
72
73  os.beginBlock(word(this->name() + "Coeffs"));
74  writeEntries(os);
75  os.endBlock();
76 }
77
78
79 // ************************************************************************* //
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:73
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::TimeState::timeToUserTime
virtual scalar timeToUserTime(const scalar t) const
Convert the real-time (s) into user-time (e.g. CA deg)
Definition: TimeState.C:55
bool read(const char *buf, int32_t &val)
Definition: int32.H:108
Foam::Function1Types::ramp::writeData
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: ramp.C:68
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:41
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:166
Foam::token::END_STATEMENT
End entry [isseparator].
Definition: token.H:121
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:111
Foam::Function1Types::ramp::convertTimeBase
virtual void convertTimeBase(const Time &t)
Convert time.
Definition: ramp.C:61
Foam::nl
constexpr char nl
Definition: Ostream.H:385
Foam::Function1Types::ramp::writeEntries
void writeEntries(Ostream &os) const
Write coefficient entries in dictionary format.
Definition: ramp.C:54
Foam::Function1Types::ramp::start_
scalar start_
Start-time of the ramp function.
Definition: ramp.H:108
Foam::Ostream::writeEntry
Ostream & writeEntry(const keyType &key, const T &value)
Write a keyword/value entry.
Definition: Ostream.H:232
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
ramp.H