fieldValueI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #include "fieldValue.H"
27 #include "fvMesh.H"
28 
29 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
30 
32 {
33  return dict_;
34 }
35 
36 
38 {
39  return regionName_;
40 }
41 
42 
44 {
45  return fields_;
46 }
47 
48 
49 inline const Foam::Switch&
51 {
52  return writeFields_;
53 }
54 
55 
56 inline const Foam::dictionary&
58 {
59  return resultDict_;
60 }
61 
62 
63 // ************************************************************************* //
dictionary dict_
Construction dictionary.
Definition: fieldValue.H:73
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
A simple wrapper around bool so that it can be read as a word: true/false, on/off, yes/no, y/n, t/f, or none/any.
Definition: Switch.H:60
const Switch & writeFields() const
Return the output field values flag.
Definition: fieldValueI.H:50
Switch writeFields_
Output field values flag.
Definition: fieldValue.H:82
dictionary resultDict_
Results dictionary for external access of results.
Definition: fieldValue.H:85
A class for handling words, derived from string.
Definition: word.H:59
const dictionary & resultDict() const
Return access to the latest set of results.
Definition: fieldValueI.H:57
const dictionary & dict() const
Return the reference to the construction dictionary.
Definition: fieldValueI.H:31
wordList fields_
List of field names to operate on.
Definition: fieldValue.H:79
const wordList & fields() const
Return the list of field names.
Definition: fieldValueI.H:43
word regionName_
Name of region (patch, zone, etc.)
Definition: fieldValue.H:76
const word & regionName() const
Return the region name.
Definition: fieldValueI.H:37