calcEntry.C
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-2013 OpenFOAM Foundation
9 Copyright (C) 2018-2021 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
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\*---------------------------------------------------------------------------*/
28
29#include "calcEntry.H"
30#include "codeStream.H"
31#include "dictionary.H"
32#include "dynamicCode.H"
34
35// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
36
37namespace Foam
38{
39namespace functionEntries
40{
42 (
45 execute,
46 dictionaryIstream,
47 calc
48 );
49
51 (
54 execute,
55 primitiveEntryIstream,
56 calc
57 );
58} // End namespace functionEntries
59} // End namespace Foam
60
61
62// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
63
65(
66 const dictionary& parentDict,
67 Istream& is
68)
69{
71 << "Using #calc - line "
72 << is.lineNumber() << " in file "
73 << parentDict.relativeName() << nl;
74
76 (
77 "functionEntries::calcEntry::evaluate(..)",
78 parentDict
79 );
80
81 // Read string
82 string s(is);
83
84 // Construct codeDict for codeStream
85 dictionary codeSubDict;
86 codeSubDict.add("code", "os << (" + s + ");");
87 dictionary codeDict(parentDict, codeSubDict);
88
89 // Use function to write stream
90 OStringStream os(is.format());
91
92 streamingFunctionType function = getFunction(parentDict, codeDict);
93 (*function)(os, parentDict);
94
95 // Return evaluated content as string
96 return os.str();
97}
98
99
100// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
101
103(
104 const dictionary& parentDict,
106 Istream& is
107)
108{
109 IStringStream result(evaluate(parentDict, is));
110 entry.read(parentDict, result);
111
112 return true;
113}
114
115
117(
118 dictionary& parentDict,
119 Istream& is
120)
121{
122 IStringStream result(evaluate(parentDict, is));
123 parentDict.read(result);
124
125 return true;
126}
127
128
129// ************************************************************************* //
Macros for easy insertion into member function selection tables.
#define addNamedToMemberFunctionSelectionTable(baseType, thisType, funcName, argNames, lookupName)
Add to hash-table of functions with 'lookupName' as the key.
void evaluate()
Evaluate boundary conditions.
Input from string buffer, using a ISstream. Always UNCOMPRESSED.
Definition: StringStream.H:112
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:64
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
bool read(Istream &is)
Read dictionary from Istream. Discards the header.
Definition: dictionaryIO.C:141
static void checkSecurity(const char *title, const dictionary &)
Check security for creating dynamic code.
Definition: dynamicCode.C:65
A keyword and a list of tokens is an 'entry'.
Definition: entry.H:70
Uses dynamic compilation to provide calculating functionality for entering dictionary entries.
Definition: calcEntry.H:72
static streamingFunctionType getFunction(const dictionary &parentDict, const dictionary &codeDict)
Construct, compile, load and return streaming function.
Definition: codeStream.C:107
void(* streamingFunctionType)(Ostream &, const dictionary &)
Interpreter function type.
Definition: codeStream.H:123
A functionEntry causes entries to be added/manipulated on the specified dictionary given an input str...
Definition: functionEntry.H:69
virtual bool execute()
Calculate the output fields.
A keyword and a list of tokens comprise a primitiveEntry. A primitiveEntry can be read,...
A class for handling character strings derived from std::string.
Definition: string.H:79
#define DetailInfo
Definition: evalEntry.C:37
OBJstream os(runTime.globalPath()/outputName)
gmvFile<< "tracers "<< particles.size()<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().x()<< " ";}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().y()<< " ";}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().z()<< " ";}gmvFile<< nl;forAll(lagrangianScalarNames, i){ word name=lagrangianScalarNames[i];IOField< scalar > s(IOobject(name, runTime.timeName(), cloud::prefix, mesh, IOobject::MUST_READ, IOobject::NO_WRITE))
Namespace for OpenFOAM.
constexpr char nl
The newline '\n' character (0x0a)
Definition: Ostream.H:53