OpenFOAM: API Guide
v2006
The open source CFD toolbox
SineI.H
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) 2017 OpenFOAM Foundation
9
-------------------------------------------------------------------------------
10
License
11
This file is part of OpenFOAM.
12
13
OpenFOAM is free software: you can redistribute it and/or modify it
14
under the terms of the GNU General Public License as published by
15
the Free Software Foundation, either version 3 of the License, or
16
(at your option) any later version.
17
18
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21
for more details.
22
23
You should have received a copy of the GNU General Public License
24
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26
\*---------------------------------------------------------------------------*/
27
28
#include "
Sine.H
"
29
#include "
mathematicalConstants.H
"
30
31
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
32
33
template
<
class
Type>
34
inline
Type
Foam::Function1Types::Sine<Type>::value
(
const
scalar t)
const
35
{
36
return
37
amplitude_->value(t)
38
*
sin
(
constant::mathematical::twoPi
*frequency_->value(t)*(t - t0_))
39
*scale_->
value
(t)
40
+ level_->value(t);
41
}
42
43
44
// ************************************************************************* //
mathematicalConstants.H
Sine.H
Foam::sin
dimensionedScalar sin(const dimensionedScalar &ds)
Definition:
dimensionedScalar.C:264
Foam::dimensioned::value
const Type & value() const
Return const reference to value.
Definition:
dimensionedType.C:434
Foam::Function1Types::Sine::value
virtual Type value(const scalar t) const
Return value for time t.
Definition:
SineI.H:34
Foam::constant::mathematical::twoPi
constexpr scalar twoPi(2 *M_PI)
src
OpenFOAM
primitives
functions
Function1
Sine
SineI.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.