halfCosineRamp.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 Copyright (C) 2020-2021 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27Class
28 Foam::Function1Types::halfCosineRamp
29
30Description
31 Half-cosine ramp function starting from 0 and increasing to 1 from \c start
32 over the \c duration and remaining at 1 thereafter.
33
34See also
35 Foam::Function1Types::ramp
36
37SourceFiles
38 halfCosineRamp.C
39
40\*---------------------------------------------------------------------------*/
41
42#ifndef Function1Types_halfCosineRamp_H
43#define Function1Types_halfCosineRamp_H
44
45#include "ramp.H"
46
47// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48
49namespace Foam
50{
51namespace Function1Types
52{
53
54/*---------------------------------------------------------------------------*\
55 Class halfCosineRamp Declaration
56\*---------------------------------------------------------------------------*/
59:
60 public ramp
61{
62public:
63
64 //- Runtime type information
65 TypeName("halfCosineRamp");
66
67
68 // Constructors
69
70 //- Construct from entry name, dictionary and optional registry
72 (
73 const word& entryName,
74 const dictionary& dict,
75 const objectRegistry* obrPtr = nullptr
76 );
77
78
79 //- Destructor
80 virtual ~halfCosineRamp() = default;
81
82
83 // Member Functions
84
85 //- Return value for time t
86 virtual inline scalar value(const scalar t) const;
87};
88
89
90// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91
92} // End namespace Function1Types
93} // End namespace Foam
94
95// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96
97#include "halfCosineRampI.H"
98
99// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100
101#endif
102
103// ************************************************************************* //
Half-cosine ramp function starting from 0 and increasing to 1 from start over the duration and remain...
virtual scalar value(const scalar t) const
Return value for time t.
virtual ~halfCosineRamp()=default
Destructor.
TypeName("halfCosineRamp")
Runtime type information.
Ramp function base class for the set of scalar functions starting from 0 and increasing monotonically...
Definition: ramp.H:102
const word const dictionary & dict
Definition: Function1.H:134
const word const dictionary const objectRegistry * obrPtr
Definition: Function1.H:136
const word & entryName
Definition: Function1.H:133
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Registry of regIOobjects.
A class for handling words, derived from Foam::string.
Definition: word.H:68
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73