OpenFOAM
v2312
The open source CFD toolbox
removeEntry.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 OpenFOAM Foundation
9
Copyright (C) 2017 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
Class
28
Foam::functionEntries::removeEntry
29
30
Description
31
Remove a dictionary entry.
32
33
The \c \#remove directive takes a list or a single keyType.
34
For example,
35
\verbatim
36
#remove entry0
37
#remove ( entry1 entry2 entry3 otherEntry )
38
#remove "entry[1-3]"
39
#remove ( "entry[1-3]" otherEntry )
40
#remove ^dict1.subdict2.entry2
41
#remove "/dict1/subdict2/entry1"
42
\endverbatim
43
44
Note
45
Unless otherwise scoped, the removal occurs in the current context.
46
To remove from other scopes, a dot-scoped or slash-scoped syntax is
47
required. The slash-scoped syntax must be quoted to ensure that it
48
is properly parsed.
49
50
SourceFiles
51
removeEntry.C
52
53
\*---------------------------------------------------------------------------*/
54
55
#ifndef functionEntries_removeEntry_H
56
#define functionEntries_removeEntry_H
57
58
#include "
functionEntry.H
"
59
60
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
61
62
namespace
Foam
63
{
64
namespace
functionEntries
65
{
66
67
/*---------------------------------------------------------------------------*\
68
Class removeEntry Declaration
69
\*---------------------------------------------------------------------------*/
70
71
class
removeEntry
72
:
73
public
functionEntry
74
{
75
public
:
76
77
//- Remove single or multiple entries. Local or scoped entries.
78
static
bool
execute
(
dictionary
& parentDict,
Istream
& is);
79
};
80
81
82
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83
84
}
// End namespace functionEntries
85
}
// End namespace Foam
86
87
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88
89
#endif
90
91
// ************************************************************************* //
Foam::functionEntries::removeEntry::execute
static bool execute(dictionary &parentDict, Istream &is)
Remove single or multiple entries. Local or scoped entries.
Definition:
removeEntry.C:48
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition:
dictionary.H:129
functionEntry.H
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition:
Istream.H:57
Foam::functionEntry
A functionEntry causes entries to be added/manipulated on the specified dictionary given an input str...
Definition:
functionEntry.H:63
Foam::functionEntries::removeEntry
Remove a dictionary entry.
Definition:
removeEntry.H:66
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:26
src
OpenFOAM
db
dictionary
functionEntries
removeEntry
removeEntry.H
Generated by
1.8.14