Square.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) 2016-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 "Square.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Type>
32 (
33  const word& name,
34  const unitConversions& units,
35  const dictionary& dict
36 )
37 :
38  FieldFunction1<Type, Square<Type>>(name),
39  amplitude_(Function1<Type>::New("amplitude", units, dict)),
40  frequency_(dict.lookup<scalar>("frequency", unitless/units.x)),
41  start_(dict.lookupOrDefault<scalar>("start", units.x, 0)),
42  level_(Function1<Type>::New("level", units, dict)),
43  markSpace_(dict.lookupOrDefault<scalar>("markSpace", unitless, 1)),
44  integrable_(amplitude_->constant() && level_->constant())
45 {}
46 
47 
48 template<class Type>
50 :
51  FieldFunction1<Type, Square<Type>>(se),
52  amplitude_(se.amplitude_, false),
53  frequency_(se.frequency_),
54  start_(se.start_),
55  level_(se.level_, false),
56  markSpace_(se.markSpace_),
57  integrable_(se.integrable_)
58 {}
59 
60 
61 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
62 
63 template<class Type>
65 {}
66 
67 
68 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
69 
70 template<class Type>
72 (
73  Ostream& os,
74  const unitConversions& units
75 ) const
76 {
77  writeEntry(os, units, amplitude_());
78  writeEntry(os, "frequency", unitless/units.x, frequency_);
79  writeEntry(os, "start", units.x, start_);
80  writeEntry(os, units, level_());
81  writeEntry(os, "markSpace", unitless, markSpace_);
82 }
83 
84 
85 // ************************************************************************* //
Run-time selectable general function of one variable.
Definition: Function1.H:125
Templated square-wave function with support for an offset level.
Definition: Square.H:134
virtual ~Square()
Destructor.
Definition: Square.C:64
Square(const word &name, const unitConversions &units, const dictionary &dict)
Construct from name and dictionary.
Definition: Square.C:32
virtual void write(Ostream &os, const unitConversions &units) const
Write data to dictionary stream.
Definition: Square.C:72
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
autoPtr< CompressibleMomentumTransportModel > New(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const viscosity &viscosity)
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.
const unitConversion unitless
dictionary dict