LimitRange.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) 2020 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "LimitRange.H"
29 
30 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
31 
32 template<class Type>
33 void Foam::Function1Types::LimitRange<Type>::read(const dictionary& coeffs)
34 {
35  min_ = coeffs.get<scalar>("min");
36  max_ = coeffs.get<scalar>("max");
37  value_ = Function1<Type>::New("value", coeffs);
38 }
39 
40 
41 template<class Type>
43 (
44  const word& entryName,
45  const dictionary& dict
46 )
47 :
48  Function1<Type>(entryName)
49 {
50  read(dict);
51 }
52 
53 
54 template<class Type>
56 :
57  Function1<Type>(rhs),
58  min_(rhs.min_),
59  max_(rhs.max_),
60  value_(rhs.value_.clone())
61 {}
62 
63 
64 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
65 
66 template<class Type>
68 {
69  os.writeEntry("min", min_);
70  os.writeEntry("max", max_);
71  value_->writeData(os);
72 }
73 
74 
75 template<class Type>
77 {
79  os << token::END_STATEMENT << nl;
80 
81  os.beginBlock(word(this->name() + "Coeffs"));
82  writeEntries(os);
83  os.endBlock();
84 }
85 
86 
87 // ************************************************************************* //
Foam::Function1Types::LimitRange
Function1 wrapper that limits the input range of another Function1.
Definition: LimitRange.H:114
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
LimitRange.H
Foam::Ostream::beginBlock
virtual Ostream & beginBlock(const keyType &kw)
Write begin block group with the given name.
Definition: Ostream.C:91
Foam::Function1
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:86
Foam::name
word name(const complex &c)
Return string representation of complex.
Definition: complex.C:76
Foam::Function1::writeData
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Function1.C:166
Foam::token::END_STATEMENT
End entry [isseparator].
Definition: token.H:121
Foam::blockMeshTools::read
void read(Istream &, label &, const dictionary &)
In-place read with dictionary lookup.
Definition: blockMeshTools.C:33
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::Ostream::endBlock
virtual Ostream & endBlock()
Write end block group.
Definition: Ostream.C:109
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
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::nl
constexpr char nl
Definition: Ostream.H:385
Foam::Ostream::writeEntry
Ostream & writeEntry(const keyType &key, const T &value)
Write a keyword/value entry.
Definition: Ostream.H:232
Foam::Function1Types::LimitRange::writeEntries
void writeEntries(Ostream &os) const
Write coefficient entries in dictionary format.
Definition: LimitRange.C:67
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::Function1Types::LimitRange::LimitRange
LimitRange(const word &entryName, const dictionary &dict)
Construct from entry name and dictionary.
Definition: LimitRange.C:43
Foam::Function1Types::LimitRange::writeData
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: LimitRange.C:76