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-------------------------------------------------------------------------------
11License
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
33template<class Type>
34void 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
43template<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
57template<class Type>
59:
60 Function1<Type>(rhs),
61 scale_(rhs.scale_.clone()),
62 value_(rhs.value_.clone())
63{}
64
65
66// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
67
68template<class Type>
70{
71 scale_->writeData(os);
72 value_->writeData(os);
73}
74
75
76template<class Type>
78{
80 os.endEntry();
81
82 os.beginBlock(word(this->name() + "Coeffs"));
83 writeEntries(os);
84 os.endBlock();
85}
86
87
88// ************************************************************************* //
Function1 which scales a given 'value' function by a scalar 'scale' function.
Definition: Scale.H:106
virtual void writeEntries(Ostream &os) const
Write coefficient entries in dictionary format.
Definition: Scale.C:69
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:96
const word const dictionary & dict
Definition: Function1.H:134
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
virtual bool read()
Re-read model coefficients if they have changed.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Registry of regIOobjects.
A class for handling words, derived from Foam::string.
Definition: word.H:68
OBJstream os(runTime.globalPath()/outputName)
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
dictionary dict