squarePulse.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) 2021-2024 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 "squarePulse.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32 namespace Function1s
33 {
35 }
36 }
37 
38 
39 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
40 
42 (
43  const word& name,
44  const unitConversions& units,
45  const dictionary& dict
46 )
47 :
49  start_(dict.lookupOrDefault<scalar>("start", units.x, 0)),
50  duration_(dict.lookup<scalar>("duration", units.x))
51 {}
52 
53 
54 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
55 
57 {}
58 
59 
60 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
61 
63 (
64  Ostream& os,
65  const unitConversions& units
66 ) const
67 {
68  writeEntry(os, "start", units.x, start_);
69  writeEntry(os, "duration", units.x, duration_);
70 }
71 
72 
73 // ************************************************************************* //
Square pulse function. Takes a value of 0 before start, then rises instantaneously to 1,...
Definition: squarePulse.H:99
virtual void write(Ostream &os, const unitConversions &units) const
Write data to dictionary stream.
Definition: squarePulse.C:63
virtual ~squarePulse()
Destructor.
Definition: squarePulse.C:56
squarePulse(const word &name, const unitConversions &units, const dictionary &dict)
Construct from name and dictionary.
Definition: squarePulse.C:42
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
A class for handling words, derived from string.
Definition: word.H:62
void writeEntry(Ostream &os, const omega &a)
Definition: omega1.C:97
addScalarFunction1(laminarBL)
Namespace for OpenFOAM.
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
const HashTable< unitConversion > & units()
Get the table of unit conversions.
dictionary dict