Sine.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 | Copyright (C) 2016 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 "Sine.H"
27 #include "mathematicalConstants.H"
28 
29 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
30 
31 template<class Type>
32 void Foam::Function1Types::Sine<Type>::read(const dictionary& coeffs)
33 {
34  t0_ = coeffs.lookupOrDefault<scalar>("t0", 0);
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  const word& ext
48 )
49 :
50  Function1<Type>(entryName)
51 {
52  read(dict.subDict(entryName + ext));
53 }
54 
55 
56 template<class Type>
58 :
59  Function1<Type>(se),
60  t0_(se.t0_),
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>
78 Type Foam::Function1Types::Sine<Type>::value(const scalar t) const
79 {
80  return
81  amplitude_->value(t)
82  *sin(constant::mathematical::twoPi*frequency_->value(t)*(t - t0_))
83  *scale_->value(t)
84  + level_->value(t);
85 }
86 
87 
88 template<class Type>
90 {
92  os << token::END_STATEMENT << nl;
93  os << indent << word(this->name() + "Coeffs") << nl;
94  os << indent << token::BEGIN_BLOCK << incrIndent << nl;
95  os.writeKeyword("t0") << t0_ << token::END_STATEMENT << nl;
96  amplitude_->writeData(os);
97  frequency_->writeData(os);
98  scale_->writeData(os);
99  level_->writeData(os);
100  os << decrIndent << indent << token::END_BLOCK << endl;
101 }
102 
103 
104 // ************************************************************************* //
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:53
const word & name() const
Return the name of the entry.
Definition: Function1.C:56
Ostream & indent(Ostream &os)
Indent stream.
Definition: Ostream.H:223
Sine(const word &entryName, const dictionary &dict, const word &ext="Coeffs")
Construct from entry name and dictionary.
Definition: Sine.C:44
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual ~Sine()
Destructor.
Definition: Sine.C:71
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:633
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:253
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Function1.C:121
Templated sine function with support for an offset level.
Definition: Sine.H:126
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tdf1, const word &name, const dimensionSet &dimensions)
bool read(const char *, int32_t &)
Definition: int32IO.C:85
Type value(const scalar t) const
Return value for time t.
Definition: Sine.C:78
A class for handling words, derived from string.
Definition: word.H:59
const scalar twoPi(2 *pi)
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
dimensionedScalar sin(const dimensionedScalar &ds)
static const char nl
Definition: Ostream.H:262
Ostream & decrIndent(Ostream &os)
Decrement the indent level.
Definition: Ostream.H:237
Ostream & writeKeyword(const keyType &)
Write the keyword followed by an appropriate indentation.
Definition: Ostream.C:54
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Sine.C:89
Ostream & incrIndent(Ostream &os)
Increment the indent level.
Definition: Ostream.H:230