File size: 4,736 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2017-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::Function1s::Ramp
Description
Ramp function base class for the set of scalar functions starting from 0 and
increasing monotonically to 1 from \c start over the \c duration and
remaining at 1 thereafter.
Usage
\verbatim
<name> <rampFunction>;
<name>Coeffs
{
start 10;
duration 20;
}
\endverbatim
or
\verbatim
<name>
{
type <rampFunction>;
start 10;
duration 20;
}
\endverbatim
or including a constant scaling factor:
\verbatim
<name>
{
type scale;
scale
{
type <rampFunction>;
start 0;
duration 10;
}
value 100;
}
\endverbatim
for more details of scaling the ramp see Foam::Function1s::Scale.
Where:
\table
Property | Description | Required | Default value
start | Start time | no | 0
duration | Duration | yes |
\endtable
See also
Foam::Function1
Foam::Function1s::Scale
SourceFiles
Ramp.C
\*---------------------------------------------------------------------------*/
#ifndef Ramp_H
#define Ramp_H
#include "Function1.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace Function1s
{
/*---------------------------------------------------------------------------*\
Class Ramp Declaration
\*---------------------------------------------------------------------------*/
template<class Function1Type>
class Ramp
:
public FieldFunction1<scalar, Function1Type>
{
protected:
// Protected data
//- Start-time of the ramp function
const scalar start_;
//- Duration of the ramp function
const scalar duration_;
//- Return the end-time of the ramp function
inline scalar end() const
{
return start_ + duration_;
}
//- Simple linear ramp function which form the basis of many more
// complex ramp functions
inline scalar linearRamp(const scalar t) const
{
return max(min((t - start_)/duration_, 1), 0);
}
//- The gradient of the linear ramp within the bounds of the ramp
// duration
inline scalar dLinearRampDt() const
{
return 1/duration_;
}
public:
// Constructors
//- Construct from name and dictionary
Ramp
(
const word& name,
const unitSets& units,
const dictionary& dict
);
//- Destructor
virtual ~Ramp();
// Member Functions
//- Return the value at a scalar coordinate
virtual scalar value(const scalar t) const = 0;
//- Write in dictionary format
virtual void write(Ostream& os, const unitSets& units) const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const Ramp<Function1Type>&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Function1s
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "Ramp.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|