File size: 3,625 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2020-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::Function2s::Scale
Description
Function2 which scales a given 'value' function by a 'scale' scalar function
and scales the 'x' and 'y' arguments of the 'value' and 'scale' functions
by the optional 'xScale' and 'yScale' scalar functions.
See also
Foam::Function2s::ramp
Foam::Function2s::reverseRamp
SourceFiles
Scale.C
\*---------------------------------------------------------------------------*/
#ifndef Scale2_H
#define Scale2_H
#include "Function2.H"
#include "Function1.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace Function2s
{
/*---------------------------------------------------------------------------*\
Class Scale Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class Scale
:
public FieldFunction2<Type, Scale<Type>>
{
// Private Data
//- Scalar scaling function
const autoPtr<Function2<scalar>> scale_;
//- Argument scaling function
const autoPtr<Function1<scalar>> xScale_;
//- Argument scaling function
const autoPtr<Function1<scalar>> yScale_;
//- Value function
const autoPtr<Function2<Type>> value_;
public:
// Runtime type information
TypeName("scale");
// Constructors
//- 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 value
virtual inline Type value(const scalar x, const scalar y) const;
//- Write data to dictionary stream
virtual void write(Ostream& os, const unitSets& units) const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const Scale<Type>&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Function2s
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "Scale2I.H"
#ifdef NoRepository
#include "Scale2.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|