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 | Copyright (C) 2011-2013 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 
31 inline const Foam::word& Foam::fieldValue::name() const
32 {
33  return name_;
34 }
35 
36 
38 {
39  return obr_;
40 }
41 
42 
44 {
45  return dict_;
46 }
47 
48 
49 inline bool Foam::fieldValue::active() const
50 {
51  return active_;
52 }
53 
54 
55 inline const Foam::Switch& Foam::fieldValue::log() const
56 {
57  return log_;
58 }
59 
60 
62 {
63  return sourceName_;
64 }
65 
66 
68 {
69  return fields_;
70 }
71 
72 
74 {
75  return valueOutput_;
76 }
77 
78 
79 inline const Foam::fvMesh& Foam::fieldValue::mesh() const
80 {
81  return refCast<const fvMesh>(obr_);
82 }
83 
84 
86 {
87  return resultDict_;
88 }
89 
90 
91 // ************************************************************************* //
const wordList & fields() const
Return the list of field names.
Definition: fieldValueI.H:67
word name_
Name of this fieldValue object.
Definition: fieldValue.H:72
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
word sourceName_
Name of source object.
Definition: fieldValue.H:87
const Switch & log() const
Return the switch to send output to Info as well as to file.
Definition: fieldValueI.H:55
Switch valueOutput_
Output field values flag.
Definition: fieldValue.H:93
A class for handling words, derived from string.
Definition: word.H:59
bool active_
Active flag.
Definition: fieldValue.H:81
Switch log_
Switch to send output to Info as well as to file.
Definition: fieldValue.H:84
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.
Definition: Switch.H:60
dictionary dict_
Construction dictionary.
Definition: fieldValue.H:78
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const dictionary & dict() const
Return the reference to the construction dictionary.
Definition: fieldValueI.H:43
const dictionary & resultDict() const
Return access to the latest set of results.
Definition: fieldValueI.H:85
const fvMesh & mesh() const
Helper function to return the reference to the mesh.
Definition: fieldValueI.H:79
const word & name() const
Return the name of the geometric source.
Definition: fieldValueI.H:31
const objectRegistry & obr_
Database this class is registered to.
Definition: fieldValue.H:75
bool active() const
Return the active flag.
Definition: fieldValueI.H:49
const objectRegistry & obr() const
Return the reference to the object registry.
Definition: fieldValueI.H:37
Registry of regIOobjects.
wordList fields_
List of field names to operate on.
Definition: fieldValue.H:90
dictionary resultDict_
Results dictionary for external access of results.
Definition: fieldValue.H:96
const word & sourceName() const
Return the source name.
Definition: fieldValueI.H:61
const Switch & valueOutput() const
Return the output field values flag.
Definition: fieldValueI.H:73