All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Sine.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 "Sine.H"
27 
28 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
29 
30 template<class Type>
31 void Foam::Function1s::Sine<Type>::read(const dictionary& coeffs)
32 {
33  amplitude_ = Function1<Type>::New("amplitude", coeffs);
34  frequency_ = coeffs.lookup<scalar>("frequency");
35  start_ = coeffs.lookupOrDefault<scalar>("start", 0);
36  level_ = Function1<Type>::New("level", coeffs);
37 
38  integrable_ =
39  isA<Constant<Type>>(amplitude_())
40  && isA<Constant<Type>>(level_());
41 }
42 
43 
44 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
45 
46 template<class Type>
48 (
49  const word& entryName,
50  const dictionary& dict
51 )
52 :
54 {
55  read(dict);
56 }
57 
58 
59 template<class Type>
61 :
62  FieldFunction1<Type, Sine<Type>>(se),
63  amplitude_(se.amplitude_, false),
64  frequency_(se.frequency_),
65  start_(se.start_),
66  level_(se.level_, false),
67  integrable_(se.integrable_)
68 {}
69 
70 
71 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
72 
73 template<class Type>
75 {}
76 
77 
78 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
79 
80 template<class Type>
82 {
84  os << token::END_STATEMENT << nl;
85  os << indent << word(this->name() + "Coeffs") << nl;
86  os << indent << token::BEGIN_BLOCK << incrIndent << nl;
87  amplitude_->writeData(os);
88  writeEntry(os, "frequency", frequency_);
89  writeEntry(os, "start", start_);
90  level_->writeData(os);
91  os << decrIndent << indent << token::END_BLOCK << endl;
92 }
93 
94 
95 // ************************************************************************* //
bool isA(const Type &t)
Check if a dynamic_cast to typeid is possible.
Definition: typeInfo.H:134
Ostream & indent(Ostream &os)
Indent stream.
Definition: Ostream.H:221
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
const word & name() const
Return the name of the entry.
Definition: Function1.C:91
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
virtual ~Sine()
Destructor.
Definition: Sine.C:74
void read(Istream &, label &, const dictionary &)
In-place read with dictionary lookup.
Sine(const word &entryName, const dictionary &dict)
Construct from entry name and dictionary.
Definition: Sine.C:48
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Function1.C:98
Templated sine function with support for an offset level.
Definition: Sine.H:119
autoPtr< BasicCompressibleMomentumTransportModel > New(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const typename BasicCompressibleMomentumTransportModel::transportModel &transport)
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:54
static const char nl
Definition: Ostream.H:260
Ostream & decrIndent(Ostream &os)
Decrement the indent level.
Definition: Ostream.H:235
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Sine.C:81
Ostream & incrIndent(Ostream &os)
Increment the indent level.
Definition: Ostream.H:228