All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 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 {
34  makeScalarFunction1(reverseRamp);
35 }
36 }
37 
38 
39 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
40 
42 (
43  const word& entryName,
44  const dictionary& dict
45 )
46 :
47  Ramp<reverseRamp>(entryName, dict),
48  ramp_(Function1<scalar>::New("ramp", dict))
49 {}
50 
51 
53 (
54  const reverseRamp& rr
55 )
56 :
58  ramp_(rr.ramp_, false)
59 {}
60 
61 
62 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
63 
65 {}
66 
67 
68 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
69 
71 {
73  os << token::END_STATEMENT << nl;
74  os << indent << word(this->name() + "Coeffs") << nl;
75  os << indent << token::BEGIN_BLOCK << incrIndent << nl;
76  ramp_->writeData(os);
77  os << decrIndent << indent << token::END_BLOCK << endl;
78 }
79 
80 
81 // ************************************************************************* //
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:52
dictionary dict
Ostream & indent(Ostream &os)
Indent stream.
Definition: Ostream.H:221
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual ~reverseRamp()
Destructor.
Definition: reverseRamp.C:64
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
makeScalarFunction1(halfCosineRamp)
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: reverseRamp.C:70
A class for handling words, derived from string.
Definition: word.H:59
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
static const char nl
Definition: Ostream.H:260
Ostream & decrIndent(Ostream &os)
Decrement the indent level.
Definition: Ostream.H:235
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Ramp.C:61
reverseRamp(const word &entryName, const dictionary &dict)
Construct from entry name and dictionary.
Definition: reverseRamp.C:42
A wrapper class to reverse any ramp function such that the result starts from 1 decreasing to 0 from ...
Definition: reverseRamp.H:81
Ostream & incrIndent(Ostream &os)
Increment the indent level.
Definition: Ostream.H:228
Namespace for OpenFOAM.