Scale2.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) 2020-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 "Scale2.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Type>
32 (
33  const word& name,
34  const unitConversions& units,
35  const dictionary& dict
36 )
37 :
38  FieldFunction2<Type, Scale<Type>>(name),
39  scale_(Function2<scalar>::New("scale", units.x, units.y, unitless, dict)),
40  xScale_
41  (
42  dict.found("xScale")
43  ? Function1<scalar>::New("xScale", units.x, units.x, dict)
44  : autoPtr<Function1<scalar>>
45  (
46  new Function1s::Constant<scalar>("xScale", 1)
47  )
48  ),
49  yScale_
50  (
51  dict.found("yScale")
52  ? Function1<scalar>::New("yScale", units.y, units.y, dict)
53  : autoPtr<Function1<scalar>>
54  (
55  new Function1s::Constant<scalar>("yScale", 1)
56  )
57  ),
58  value_(Function2<Type>::New("value", units, dict))
59 {}
60 
61 
62 template<class Type>
64 :
65  FieldFunction2<Type, Scale<Type>>(se),
66  scale_(se.scale_, false),
67  xScale_(se.xScale_, false),
68  yScale_(se.yScale_, false),
69  value_(se.value_, false)
70 {}
71 
72 
73 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
74 
75 template<class Type>
77 {}
78 
79 
80 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
81 
82 template<class Type>
84 (
85  Ostream& os,
86  const unitConversions& units
87 ) const
88 {
89  writeEntry(os, units.x, units.y, unitless, scale_());
90  writeEntry(os, units.x, units.x, xScale_());
91  writeEntry(os, units.y, units.y, yScale_());
92  writeEntry(os, units, value_());
93 }
94 
95 
96 // ************************************************************************* //
scalar y
bool found
Run-time selectable general function of one variable.
Definition: Function1.H:125
Run-time selectable function of two variables.
Definition: Function2.H:98
Templated function of two variables that returns a constant value.
Definition: Constant2.H:66
Function2 which scales a given 'value' function by a 'scale' scalar function and scales the 'x' and '...
Definition: Scale2.H:61
Scale(const word &name, const unitConversions &units, const dictionary &dict)
Construct from name and dictionary.
Definition: Scale2.C:32
virtual void write(Ostream &os, const unitConversions &units) const
Write data to dictionary stream.
Definition: Scale2.C:84
virtual ~Scale()
Destructor.
Definition: Scale2.C:76
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
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
autoPtr< CompressibleMomentumTransportModel > New(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const viscosity &viscosity)
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
const HashTable< unitConversion > & units()
Get the table of unit conversions.
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
const unitConversion unitless
dictionary dict