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-2019 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>
31 void Foam::Function1Types::Square<Type>::read(const dictionary& coeffs)
32 {
33  t0_ = coeffs.lookupOrDefault<scalar>("t0", 0);
34  markSpace_ = coeffs.lookupOrDefault<scalar>("markSpace", 1);
35  amplitude_ = Function1<scalar>::New("amplitude", coeffs);
36  frequency_ = Function1<scalar>::New("frequency", coeffs);
37  scale_ = Function1<Type>::New("scale", coeffs);
38  level_ = Function1<Type>::New("level", coeffs);
39 }
40 
41 
42 template<class Type>
44 (
45  const word& entryName,
46  const dictionary& dict
47 )
48 :
49  Function1<Type>(entryName)
50 {
51  read(dict);
52 }
53 
54 
55 template<class Type>
57 :
58  Function1<Type>(se),
59  t0_(se.t0_),
60  markSpace_(se.markSpace_),
61  amplitude_(se.amplitude_, false),
62  frequency_(se.frequency_, false),
63  scale_(se.scale_, false),
64  level_(se.level_, false)
65 {}
66 
67 
68 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
69 
70 template<class Type>
72 {}
73 
74 
75 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
76 
77 template<class Type>
79 {
81  os << token::END_STATEMENT << nl;
82  os << indent << word(this->name() + "Coeffs") << nl;
83  os << indent << token::BEGIN_BLOCK << incrIndent << nl;
84  writeEntry(os, "t0", t0_);
85  writeEntry(os, "markSpace", markSpace_);
86  amplitude_->writeData(os);
87  frequency_->writeData(os);
88  scale_->writeData(os);
89  level_->writeData(os);
90  os << decrIndent << indent << token::END_BLOCK << endl;
91 }
92 
93 
94 // ************************************************************************* //
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:53
Ostream & indent(Ostream &os)
Indent stream.
Definition: Ostream.H:226
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Square.C:78
const word & name() const
Return the name of the entry.
Definition: Function1.C:56
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:256
virtual ~Square()
Destructor.
Definition: Square.C:71
void read(Istream &, label &, const dictionary &)
In-place read with dictionary lookup.
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tdf1, const word &name, const dimensionSet &dimensions)
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Function1.C:150
A class for handling words, derived from string.
Definition: word.H:59
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
static const char nl
Definition: Ostream.H:265
Ostream & decrIndent(Ostream &os)
Decrement the indent level.
Definition: Ostream.H:240
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
Templated square-wave function with support for an offset level.
Definition: Square.H:142
Ostream & incrIndent(Ostream &os)
Increment the indent level.
Definition: Ostream.H:233
Square(const word &entryName, const dictionary &dict)
Construct from entry name and dictionary.
Definition: Square.C:44