includeFuncEntry.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) 2016 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 Class
25  Foam::functionEntries::includeFuncEntry
26 
27 Description
28  Specify a functionObject dictionary file to include, expects the
29  functionObject name to follow with option arguments (without quotes).
30 
31  Searches for functionObject dictionary file in user/group/shipped
32  directories allowing for version-specific and version-independent files
33  using the following hierarchy:
34  - \b user settings:
35  - ~/.OpenFOAM/<VERSION>/caseDicts/postProcessing
36  - ~/.OpenFOAM/caseDicts/postProcessing
37  - \b group (site) settings (when $WM_PROJECT_SITE is set):
38  - $WM_PROJECT_SITE/<VERSION>/caseDicts/postProcessing
39  - $WM_PROJECT_SITE/caseDicts/postProcessing
40  - \b group (site) settings (when $WM_PROJECT_SITE is not set):
41  - $WM_PROJECT_INST_DIR/site/<VERSION>/caseDicts/postProcessing
42  - $WM_PROJECT_INST_DIR/site/caseDicts/postProcessing
43  - \b other (shipped) settings:
44  - $WM_PROJECT_DIR/etc/caseDicts/postProcessing
45 
46  The optional field arguments included in the name are inserted in 'field' or
47  'fields' entries in the functionObject dictionary and included in the name
48  of the functionObject entry to avoid conflict.
49 
50  Examples:
51  \verbatim
52  #includeFunc Q
53  #includeFunc components(U)
54  #includeFunc mag(Ux)
55  #includeFunc mag(p)
56  \endverbatim
57 
58 See also
59  Foam::functionObjectList
60 
61 SourceFiles
62  includeFuncEntry.C
63 
64 \*---------------------------------------------------------------------------*/
65 
66 #ifndef includeFuncEntry_H
67 #define includeFuncEntry_H
68 
69 #include "functionEntry.H"
70 
71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72 
73 namespace Foam
74 {
75 namespace functionEntries
76 {
77 
78 /*---------------------------------------------------------------------------*\
79  Class includeFuncEntry Declaration
80 \*---------------------------------------------------------------------------*/
81 
82 class includeFuncEntry
83 :
84  public functionEntry
85 {
86 
87 public:
88 
89  //- Runtime type information
90  ClassName("includeFunc");
91 
92 
93  // Member Functions
94 
95  //- Execute the functionEntry in a sub-dict context
96  static bool execute(dictionary& parentDict, Istream&);
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace functionEntries
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Specify a functionObject dictionary file to include, expects the functionObject name to follow with o...
ClassName("includeFunc")
Runtime type information.
A functionEntry causes entries to be added/manipulated on the specified dictionary given an input str...
Definition: functionEntry.H:63
static bool execute(dictionary &parentDict, Istream &)
Execute the functionEntry in a sub-dict context.
Namespace for OpenFOAM.