quarterSineRamp.H
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) 2017-2024 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 Class
25  Foam::Function1s::quarterSineRamp
26 
27 Description
28  Quarter-sine ramp function starting from 0 and increasing to 1 from \c start
29  over the \c duration and remaining at 1 thereafter.
30 
31 See also
32  Foam::Function1s::Ramp
33 
34 SourceFiles
35  quarterSineRamp.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef quarterSineRamp_H
40 #define quarterSineRamp_H
41 
42 #include "Ramp.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 namespace Function1s
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class quarterSineRamp Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class quarterSineRamp
56 :
57  public Ramp<quarterSineRamp>
58 {
59 
60 public:
61 
62  // Runtime type information
63  TypeName("quarterSineRamp");
64 
65 
66  // Constructors
67 
68  //- Construct from name and dictionary
70  (
71  const word& name,
72  const unitConversions& units,
73  const dictionary& dict
74  );
75 
76 
77  //- Destructor
78  virtual ~quarterSineRamp();
79 
80 
81  // Member Functions
82 
83  //- Return value for time t
84  virtual inline scalar value(const scalar t) const;
85 
86  //- Return the integral between times t1 and t2
87  virtual inline scalar integral
88  (
89  const scalar t1,
90  const scalar t2
91  ) const;
92 
93 
94  // Member Operators
95 
96  //- Disallow default bitwise assignment
97  void operator=(const quarterSineRamp&) = delete;
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace Function1s
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #include "quarterSineRampI.H"
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
const word & name() const
Return the name of the entry.
Definition: Function1.C:78
Ramp function base class for the set of scalar functions starting from 0 and increasing monotonically...
Definition: Ramp.H:119
Quarter-sine ramp function starting from 0 and increasing to 1 from start over the duration and remai...
quarterSineRamp(const word &name, const unitConversions &units, const dictionary &dict)
Construct from name and dictionary.
virtual scalar value(const scalar t) const
Return value for time t.
virtual scalar integral(const scalar t1, const scalar t2) const
Return the integral between times t1 and t2.
void operator=(const quarterSineRamp &)=delete
Disallow default bitwise assignment.
virtual ~quarterSineRamp()
Destructor.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
const HashTable< unitConversion > & units()
Get the table of unit conversions.
dictionary dict