Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
OpenFOAM
db
dictionary
functionEntries
functionEntry
functionEntry.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) 1991-2010 OpenCFD Ltd.
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
Namespace
25
Foam::functionEntries
26
27
Description
28
Namespace for containing a functionEntry.
29
30
31
Class
32
Foam::functionEntry
33
34
Description
35
A functionEntry causes entries to be added/manipulated on the specified
36
dictionary given an input stream.
37
38
In dictionaries, a @c '\#' sigil is typically used for a functionEntry.
39
40
SourceFiles
41
functionEntry.C
42
functionEntryIO.C
43
44
\*---------------------------------------------------------------------------*/
45
46
#ifndef functionEntry_H
47
#define functionEntry_H
48
49
#include <
OpenFOAM/word.H
>
50
#include <
OpenFOAM/memberFunctionSelectionTables.H
>
51
52
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
53
54
namespace
Foam
55
{
56
57
class
primitiveEntry;
58
class
dictionary;
59
60
/*---------------------------------------------------------------------------*\
61
Class functionEntry Declaration
62
\*---------------------------------------------------------------------------*/
63
64
class
functionEntry
65
{
66
// Private Member Functions
67
68
//- Disallow default bitwise copy construct
69
functionEntry
(
const
functionEntry
&);
70
71
//- Disallow default bitwise assignment
72
void
operator=(
const
functionEntry
&);
73
74
75
public
:
76
77
// Member Function Selectors
78
79
declareMemberFunctionSelectionTable
80
(
81
bool
,
82
functionEntry
,
83
execute
,
84
dictionaryIstream,
85
(
86
dictionary
& parentDict,
87
Istream
& is
88
),
89
(parentDict, is)
90
);
91
92
//- Execute the functionEntry in a sub-dict context
93
static
bool
execute
94
(
95
const
word
& functionName,
96
dictionary
& parentDict,
97
Istream
&
98
);
99
100
declareMemberFunctionSelectionTable
101
(
102
bool
,
103
functionEntry
,
104
execute,
105
primitiveEntryIstream,
106
(
107
const
dictionary
& parentDict,
108
primitiveEntry
&
entry
,
109
Istream
& is
110
),
111
(parentDict, entry, is)
112
);
113
114
//- Execute the functionEntry in a primitiveEntry context
115
static
bool
execute
116
(
117
const
word
& functionName,
118
const
dictionary
& parentDict,
119
primitiveEntry
&,
120
Istream
&
121
);
122
123
124
};
125
126
127
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128
129
}
// End namespace Foam
130
131
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132
133
#endif
134
135
// ************************ vim: set sw=4 sts=4 et: ************************ //