Scale.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2017 OpenFOAM Foundation
9  Copyright (C) 2020-2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "Scale.H"
30 
31 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
32 
33 template<class Type>
34 void Foam::Function1Types::Scale<Type>::read(const dictionary& coeffs)
35 {
36  scale_ = Function1<scalar>::New("scale", coeffs, this->obrPtr_);
37  value_ = Function1<Type>::New("value", coeffs, this->obrPtr_);
38 }
39 
40 
41 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
42 
43 template<class Type>
45 (
46  const word& entryName,
47  const dictionary& dict,
48  const objectRegistry* obrPtr
49 )
50 :
51  Function1<Type>(entryName, obrPtr)
52 {
53  read(dict);
54 }
55 
56 
57 template<class Type>
59 :
60  Function1<Type>(rhs),
61  scale_(rhs.scale_.clone()),
62  value_(rhs.value_.clone())
63 {}
64 
65 
66 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
67 
68 template<class Type>
70 {
71  scale_->writeData(os);
72  value_->writeData(os);
73 }
74 
75 
76 template<class Type>
78 {
80  os.endEntry();
81 
82  os.beginBlock(word(this->name() + "Coeffs"));
83  writeEntries(os);
84  os.endBlock();
85 }
86 
87 
88 // ************************************************************************* //
Foam::Function1Types::Scale::Scale
Scale(const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
Construct from entry name, dictionary and optional registry.
Definition: Scale.C:45
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::Function1Types::Scale::writeData
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Scale.C:77
Foam::Function1
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: propellerInfo.H:291
Scale.H
Foam::objectRegistry
Registry of regIOobjects.
Definition: objectRegistry.H:60
Foam::blockMeshTools::read
void read(Istream &, label &val, const dictionary &)
In-place read with dictionary lookup.
Definition: blockMeshTools.C:57
Foam::Function1Types::Scale
Function1 which scales a given 'value' function by a scalar 'scale' function.
Definition: Scale.H:103
Foam::Function1::writeData
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Function1.C:174
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
os
OBJstream os(runTime.globalPath()/outputName)
Foam::New
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tdf1, const word &name, const dimensionSet &dimensions)
Global function forwards to reuseTmpDimensionedField::New.
Definition: DimensionedFieldReuseFunctions.H:105
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::Function1Types::Scale::writeEntries
void writeEntries(Ostream &os) const
Write coefficient entries in dictionary format.
Definition: Scale.C:69