reverseRamp.C
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) 2019-2026 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 \*---------------------------------------------------------------------------*/
25 
26 #include "reverseRamp.H"
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace Function1s
34 {
36 }
37 }
38 
39 
40 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41 
43 (
44  const word& name,
45  const unitSets& units,
46  const dictionary& dict
47 )
48 :
49  Ramp<reverseRamp>(name, units, dict),
50  ramp_(Function1<scalar>::New("ramp", units.x, dimless, dict))
51 {}
52 
53 
55 (
56  const reverseRamp& rr
57 )
58 :
59  Ramp<reverseRamp>(rr),
60  ramp_(rr.ramp_, false)
61 {}
62 
63 
64 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
65 
67 {}
68 
69 
70 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
71 
73 (
74  Ostream& os,
75  const unitSets& units
76 ) const
77 {
78  Ramp<reverseRamp>::write(os, units);
79  writeEntry(os, units, ramp_());
80 }
81 
82 
83 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
Run-time selectable general function of one variable.
Definition: Function1.H:62
Ramp function base class for the set of scalar functions starting from 0 and increasing monotonically...
Definition: Ramp.H:119
virtual void write(Ostream &os, const unitSets &units) const
Write data to dictionary stream.
Definition: Ramp.C:55
A wrapper class to reverse any ramp function such that the result starts from 1 decreasing to 0 from ...
Definition: reverseRamp.H:85
reverseRamp(const word &name, const unitSets &units, const dictionary &dict)
Construct from name and dictionary.
Definition: reverseRamp.C:43
virtual void write(Ostream &os, const unitSets &units) const
Write data to dictionary stream.
Definition: reverseRamp.C:73
virtual ~reverseRamp()
Destructor.
Definition: reverseRamp.C:66
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
A class for handling words, derived from string.
Definition: word.H:63
void writeEntry(Ostream &os, const omega &a)
Definition: omega1.C:99
addScalarFunction1(laminarBL)
const dimensionSet dimless
Namespace for OpenFOAM.
word name(const LagrangianState state)
Return a string representation of a Lagrangian state enumeration.
tmp< DimensionedField< TypeR, GeoMesh, Field > > New(const tmp< DimensionedField< TypeR, GeoMesh, Field >> &tdf1, const word &name, const dimensionSet &dimensions)
dictionary dict
Struct containing two unitSets for use in converting both the argument and the value of a Function1.