SquareI.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 "Square.H"
29 
30 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
31 
32 template<class Type>
33 inline Type Foam::Function1Types::Square<Type>::value(const scalar t) const
34 {
35  // Number of waves including fractions
36  scalar waves = frequency_->value(t)*(t - t0_);
37 
38  // Number of complete waves
39  scalar nWaves;
40 
41  // Fraction of last incomplete wave
42  scalar waveFrac = std::modf(waves, &nWaves);
43 
44  // Mark fraction of a wave
45  scalar markFrac = markSpace_/(1.0 + markSpace_);
46 
47  return
48  amplitude_->value(t)
49  *(waveFrac < markFrac ? 1 : -1)
50  *scale_->value(t)
51  + level_->value(t);
52 }
53 
54 
55 // ************************************************************************* //
Square.H
Foam::Function1Types::Square::value
virtual Type value(const scalar t) const
Return value for time t.
Definition: SquareI.H:33