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-2024 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"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32 namespace Function1s
33 {
35 }
36 }
37 
38 
39 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
40 
42 (
43  const word& name,
44  const unitConversions& units,
45  const dictionary& dict
46 )
47 :
49  ramp_(Function1<scalar>::New("ramp", units.x, dimless, dict))
50 {}
51 
52 
54 (
55  const reverseRamp& rr
56 )
57 :
58  Ramp<reverseRamp>(rr),
59  ramp_(rr.ramp_, false)
60 {}
61 
62 
63 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
64 
66 {}
67 
68 
69 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
70 
72 (
73  Ostream& os,
74  const unitConversions& units
75 ) const
76 {
78  writeEntry(os, units, ramp_());
79 }
80 
81 
82 // ************************************************************************* //
Run-time selectable general function of one variable.
Definition: Function1.H:125
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 unitConversions &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
virtual void write(Ostream &os, const unitConversions &units) const
Write data to dictionary stream.
Definition: reverseRamp.C:72
reverseRamp(const word &name, const unitConversions &units, const dictionary &dict)
Construct from name and dictionary.
Definition: reverseRamp.C:42
virtual ~reverseRamp()
Destructor.
Definition: reverseRamp.C:65
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
A class for handling words, derived from string.
Definition: word.H:62
void writeEntry(Ostream &os, const omega &a)
Definition: omega1.C:97
addScalarFunction1(laminarBL)
autoPtr< CompressibleMomentumTransportModel > New(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const viscosity &viscosity)
Namespace for OpenFOAM.
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
const dimensionSet dimless
const HashTable< unitConversion > & units()
Get the table of unit conversions.
dictionary dict