Scale.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) 2017-2018 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 "Scale.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Type>
31 void Foam::Function1Types::Scale<Type>::read(const dictionary& coeffs)
32 {
33  xScale_ = coeffs.found("xScale")
34  ? Function1<scalar>::New("xScale", coeffs)
35  : autoPtr<Function1<scalar>>(new Constant<scalar>("xScale", 1));
36 
37  scale_ = Function1<scalar>::New("scale", coeffs);
38  value_ = Function1<Type>::New("value", coeffs);
39 }
40 
41 
42 template<class Type>
44 (
45  const word& entryName,
46  const dictionary& dict
47 )
48 :
49  Function1<Type>(entryName)
50 {
51  read(dict);
52 }
53 
54 
55 template<class Type>
57 :
58  Function1<Type>(se),
59  xScale_(se.xScale_, false),
60  scale_(se.scale_, false),
61  value_(se.value_, false)
62 {}
63 
64 
65 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
66 
67 template<class Type>
69 {}
70 
71 
72 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
73 
74 template<class Type>
76 {
78  os << token::END_STATEMENT << nl;
79  os << indent << word(this->name() + "Coeffs") << nl;
80  os << indent << token::BEGIN_BLOCK << incrIndent << nl;
81  xScale_->writeData(os);
82  scale_->writeData(os);
83  value_->writeData(os);
84  os << decrIndent << indent << token::END_BLOCK << endl;
85 }
86 
87 
88 // ************************************************************************* //
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:53
Ostream & indent(Ostream &os)
Indent stream.
Definition: Ostream.H:226
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
const word & name() const
Return the name of the entry.
Definition: Function1.C:56
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:256
void read(Istream &, label &, const dictionary &)
In-place read with dictionary lookup.
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Scale.C:75
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tdf1, const word &name, const dimensionSet &dimensions)
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Function1.C:150
A class for handling words, derived from string.
Definition: word.H:59
virtual ~Scale()
Destructor.
Definition: Scale.C:68
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
static const char nl
Definition: Ostream.H:265
Ostream & decrIndent(Ostream &os)
Decrement the indent level.
Definition: Ostream.H:240
Scale(const word &entryName, const dictionary &dict)
Construct from entry name and dictionary.
Definition: Scale.C:44
Ostream & incrIndent(Ostream &os)
Increment the indent level.
Definition: Ostream.H:233
Function1 which scales a given &#39;value&#39; function by a &#39;scale&#39; scalar function and scales the &#39;x&#39; argum...
Definition: Scale.H:147