OpenFOAM: API Guide
v2112
The open source CFD toolbox
fieldValueI.H
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) 2011-2016 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
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
30
31
inline
const
Foam::dictionary
&
Foam::functionObjects::fieldValue::dict
()
32
const noexcept
33
{
34
return
dict_
;
35
}
36
37
38
inline
const
Foam::word
&
Foam::functionObjects::fieldValue::regionName
()
39
const noexcept
40
{
41
return
regionName_;
42
}
43
44
45
inline
const
Foam::wordList
&
Foam::functionObjects::fieldValue::fields
()
46
const noexcept
47
{
48
return
fields_;
49
}
50
51
52
inline
bool
Foam::functionObjects::fieldValue::writeFields
() const noexcept
53
{
54
return
writeFields_;
55
}
56
57
58
// ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition:
word.H:65
Foam::functionObjects::fieldValue::fields
const wordList & fields() const noexcept
Return the list of field names.
Definition:
fieldValueI.H:45
Foam::functionObjects::fieldValue::regionName
const word & regionName() const noexcept
Return the region name.
Definition:
fieldValueI.H:38
Foam::functionObjects::fieldValue::dict_
dictionary dict_
Construction dictionary.
Definition:
fieldValue.H:138
Foam::functionObjects::fieldValue::writeFields
bool writeFields() const noexcept
Return the output field values flag.
Definition:
fieldValueI.H:52
Foam::functionObjects::fieldValue::dict
const dictionary & dict() const noexcept
Return the reference to the construction dictionary.
Definition:
fieldValueI.H:31
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition:
dictionary.H:123
Foam::List< word >
src
functionObjects
field
fieldValues
fieldValue
fieldValueI.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.