File size: 6,109 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 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::Scale
Description
Function1 which scales a given 'value' function by a 'scale' scalar function
and scales the 'x' argument of the 'value' and 'scale' functions by the
optional 'xScale' scalar function.
This is particularly useful to ramp a time-varying value by one of the
monotonic ramp functions.
Usage
For a vector:
\verbatim
<name>
{
type scale;
scale
{
type linearRamp;
start 0;
duration 10;
}
value
{
type sine;
frequency 10;
amplitude 1;
scale (1 0.1 0);
level (10 1 0);
}
}
\endverbatim
Simplified usage to scale by a constant factor, e.g. 2:
\verbatim
<name>
{
type scale;
scale 2;
value
{
type sine;
frequency 10;
amplitude 1;
scale (1 0.1 0);
level (10 1 0);
}
}
\endverbatim
Including the optional 'xScale' function:
\verbatim
<name>
{
type scale;
xScale 0.5;
scale 2;
value
{
type sine;
frequency 10;
amplitude 1;
scale (1 0.1 0);
level (10 1 0);
}
}
\endverbatim
Where:
\table
Property | Description | Required
value | Function of type Function1<Type> | yes
scale | Scaling function of type Function1<scalar> | yes
xScale | 'x' scaling function of type Function1<scalar> | no
\endtable
See also
Foam::Function1s::ramp
Foam::Function1s::reverseRamp
SourceFiles
Scale.C
\*---------------------------------------------------------------------------*/
#ifndef Scale_H
#define Scale_H
#include "Function1.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace Function1s
{
/*---------------------------------------------------------------------------*\
Class Scale Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class Scale
:
public FieldFunction1<Type, Scale<Type>>
{
// Private Data
//- Scalar scaling function
const autoPtr<Function1<scalar>> scale_;
//- Is the scalar scaling function constant?
const bool constantScale_;
//- Argument scaling function
const autoPtr<Function1<scalar>> xScale_;
//- Is the argument scaling function constant?
const bool constantXScale_;
//- Value function
const autoPtr<Function1<Type>> value_;
//- Is the value function constant?
const bool constantValue_;
public:
// Runtime type information
TypeName("scale");
// Constructors
//- Construct from name and functions
Scale
(
const word& name,
const Function1<scalar>& scale,
const Function1<scalar>& xScale,
const Function1<Type>& value
);
//- Construct from name and dictionary
Scale
(
const word& name,
const unitSets& units,
const dictionary& dict
);
//- Copy constructor
Scale(const Scale<Type>& se);
//- Destructor
virtual ~Scale();
// Member Functions
//- Return the value at a scalar coordinate
virtual inline Type value(const scalar x) const;
//- Return the derivative at a scalar coordinate
virtual inline Type derivative(const scalar x) const;
//- Return the integral between two scalar coordinates
virtual inline Type integral(const scalar x1, const scalar x2) const;
//- Is this function guaranteed to be constant?
virtual inline bool constant() const;
//- Write in dictionary format
virtual void write(Ostream& os, const unitSets& units) const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const Scale<Type>&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Function1s
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "ScaleI.H"
#ifdef NoRepository
#include "Scale.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|