Square.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) 2016-2017 OpenFOAM Foundation
9  Copyright (C) 2016-2020 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
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 "Square.H"
30 
31 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32 
33 template<class Type>
34 void Foam::Function1Types::Square<Type>::read(const dictionary& coeffs)
35 {
36  t0_ = coeffs.getOrDefault<scalar>("t0", 0);
37  markSpace_ = coeffs.getOrDefault<scalar>("markSpace", 1);
38  amplitude_ = Function1<scalar>::New("amplitude", coeffs);
39  frequency_ = Function1<scalar>::New("frequency", coeffs);
40  scale_ = Function1<Type>::New("scale", coeffs);
41  level_ = Function1<Type>::New("level", coeffs);
42 }
43 
44 
45 template<class Type>
47 (
48  const word& entryName,
49  const dictionary& dict
50 )
51 :
52  Function1<Type>(entryName)
53 {
54  read(dict);
55 }
56 
57 
58 template<class Type>
60 :
61  Function1<Type>(se),
62  t0_(se.t0_),
63  markSpace_(se.markSpace_),
64  amplitude_(se.amplitude_.clone()),
65  frequency_(se.frequency_.clone()),
66  scale_(se.scale_.clone()),
67  level_(se.level_.clone())
68 {}
69 
70 
71 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
72 
73 template<class Type>
75 {
77  os.endEntry();
78 
79  os.beginBlock(word(this->name() + "Coeffs"));
80 
81  os.writeEntry("t0", t0_);
82  os.writeEntry("markSpace", markSpace_);
83  amplitude_->writeData(os);
84  frequency_->writeData(os);
85  scale_->writeData(os);
86  level_->writeData(os);
87 
88  os.endBlock();
89 }
90 
91 
92 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::Function1Types::Square::writeData
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Square.C:74
Foam::Ostream::beginBlock
virtual Ostream & beginBlock(const keyType &kw)
Write begin block group with the given name.
Definition: Ostream.C:91
Foam::Function1
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:86
Square.H
Foam::Function1Types::Square
Templated square-wave function with support for an offset level.
Definition: Square.H:144
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::Ostream::endEntry
virtual Ostream & endEntry()
Write end entry (';') followed by newline.
Definition: Ostream.C:118
Foam::blockMeshTools::read
void read(Istream &, label &, const dictionary &)
In-place read with dictionary lookup.
Definition: blockMeshTools.C:33
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::Square::Square
Square(const word &entryName, const dictionary &dict)
Construct from entry name and dictionary.
Definition: Square.C:47
Foam::New
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tdf1, const word &name, const dimensionSet &dimensions)
Global function forwards to reuseTmpDimensionedField::New.
Definition: DimensionedFieldReuseFunctions.H:105
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