OpenFOAM
v2406
The open source CFD toolbox
halfCosineRampI.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 "
halfCosineRamp.H
"
29
#include "
mathematicalConstants.H
"
30
31
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
32
33
inline
Foam::scalar
Foam::Function1Types::halfCosineRamp::value
34
(
35
const
scalar t
36
)
const
37
{
38
return
0.5*(1 -
cos
(
constant::mathematical::pi
*
linearRamp
(t)));
39
}
40
41
42
// ************************************************************************* //
mathematicalConstants.H
Foam::Function1Types::ramp::linearRamp
scalar linearRamp(const scalar t) const
Simple linear ramp function that forms the basis of many more complex ramp functions.
Definition:
ramp.H:117
halfCosineRamp.H
Foam::cos
dimensionedScalar cos(const dimensionedScalar &ds)
Definition:
dimensionedScalar.C:258
Foam::constant::mathematical::pi
constexpr scalar pi(M_PI)
Foam::Function1Types::halfCosineRamp::value
virtual scalar value(const scalar t) const
Return value for time t.
Definition:
halfCosineRampI.H:27
src
OpenFOAM
primitives
functions
Function1
halfCosineRamp
halfCosineRampI.H
Generated by
1.8.14