OpenFOAM: API Guide
v2112
The open source CFD toolbox
FunctionObjectValue.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) 2021 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 "
FunctionObjectValue.H
"
29
30
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
31
32
template
<
class
Type>
33
void
Foam::Function1Types::FunctionObjectValue<Type>::read
34
(
35
const
dictionary& coeffs
36
)
37
{
38
foName_ = coeffs.get<word>(
"functionObject"
);
39
foResultName_ = coeffs.get<word>(
"functionObjectResult"
);
40
haveDefaultValue_ = coeffs.readIfPresent(
"defaultValue"
, defaultValue_);
41
}
42
43
44
template
<
class
Type>
45
Foam::Function1Types::FunctionObjectValue<Type>::FunctionObjectValue
46
(
47
const
word
& entryName,
48
const
dictionary
&
dict
,
49
const
objectRegistry
* obrPtr
50
)
51
:
52
Function1<Type>
(entryName,
dict
, obrPtr),
53
foName_(),
54
foResultName_(),
55
defaultValue_(
Zero
),
56
haveDefaultValue_(
false
)
57
{
58
read
(
dict
);
59
}
60
61
62
template
<
class
Type>
63
Foam::Function1Types::FunctionObjectValue<Type>::FunctionObjectValue
64
(
65
const
FunctionObjectValue<Type>
& rhs
66
)
67
:
68
Function1<Type>
(rhs),
69
foName_(rhs.foName_),
70
foResultName_(rhs.foResultName_),
71
defaultValue_(rhs.defaultValue_),
72
haveDefaultValue_(rhs.haveDefaultValue_)
73
{}
74
75
76
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
77
78
template
<
class
Type>
79
void
Foam::Function1Types::FunctionObjectValue<Type>::writeEntries
80
(
81
Ostream
&
os
82
)
const
83
{
84
os
.writeEntry(
"functionObject"
, foName_);
85
os
.writeEntry(
"functionObjectResult"
, foResultName_);
86
87
if
(haveDefaultValue_)
88
{
89
os
.writeEntry(
"defaultValue"
, defaultValue_);
90
}
91
}
92
93
94
template
<
class
Type>
95
void
Foam::Function1Types::FunctionObjectValue<Type>::writeData
96
(
97
Ostream
&
os
98
)
const
99
{
100
Function1<Type>::writeData
(
os
);
101
os
.endEntry();
102
103
os
.beginBlock(
word
(this->
name
() +
"Coeffs"
));
104
writeEntries(
os
);
105
os
.endBlock();
106
}
107
108
109
// ************************************************************************* //
Foam::Function1Types::FunctionObjectValue::writeData
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition:
FunctionObjectValue.C:96
Foam::word
A class for handling words, derived from Foam::string.
Definition:
word.H:65
Foam::Zero
static constexpr const zero Zero
Global zero (0)
Definition:
zero.H:131
writeData
const bool writeData(pdfDictionary.get< bool >("writeData"))
Foam::Function1Types::FunctionObjectValue::writeEntries
void writeEntries(Ostream &os) const
Write coefficient entries in dictionary format.
Definition:
FunctionObjectValue.C:80
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
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::FunctionObjectValue::FunctionObjectValue
FunctionObjectValue(const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
Construct from entry name, dictionary and optional registry.
Definition:
FunctionObjectValue.C:46
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::Function1Types::FunctionObjectValue
Returns a value retrieved from a function object result.
Definition:
FunctionObjectValue.H:68
FunctionObjectValue.H
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
src
OpenFOAM
primitives
functions
Function1
FunctionObjectValue
FunctionObjectValue.C
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.