File size: 8,181 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::functionEntries::calcEntry
Description
Compiles and executes code string expressions,
returning the result to the dictionary entry.
\c \#calc reads the following code string to generate the library source
code stored in the local \c dynamicCode directory with a subdirectory name
corresponding to the SHA1 of the code. The code is then compiled into a
dynamically loaded library libcodeStream_<SHA1>.so stored in the \c
dynamicCode/platforms/$WM_OPTIONS/lib directory using 'wmake libso'. The
resulting library is loaded in executed with arguments
\code
(const dictionary& dict, Ostream& os)
\endcode
where the dictionary is the current dictionary. The code writes results to
the current entry via the \c Ostream \c os.
The verbatim string format \c \#{ ... \c \#} can optionally be used to allow
string/word comparison without the need to escape the quotes and multi-line
input without the need to escape the newlines.
Dictionary entries constructed \c \#calc can conveniently access and
use typed variables. This means calculations involving vectors and tensors
and list etc. are possible. To access a variable and construct it as a
given type within a \c \#calc entry, put the type immediately after the $
symbol inside angled brackets <>. So, $<vector>var or $<vector>{var}
substitutes a variable named var as a vector.
The variable values are no longer embedded into the code but looked-up at
run-time making the code corresponding to each \c \#calc independent of the
values in the dictionary and of each other. Hence the \c \#calc code does
not need to be recompiled when the values in the dictionary are changed,
only if the code is changed.
Usage
Simple variable multiplication:
\verbatim
a 1.1;
b 3.2;
c #calc "$a*$b";
\endverbatim
Special care is required for calc entries that include a division since
"/" is also used as the scoping operator to identify keywords in
sub-dictionaries. For example, "$a/b" expects a keyword "b" within a
sub-dictionary named "a". A division can be correctly executed by using a
space between a variables and "/", e.g.
\verbatim
c #calc "$a / $b";
\endverbatim
or bracketing the variable, e.g.
\verbatim
c #calc "($a)/$b";
\endverbatim
Example using the string type:
\verbatim
s "field";
fieldName #calc "$<string>s + \"Name\" ";
\endverbatim
Additional include files for the \c \#calc code compilation can be specified
using the \c \#codeInclude entry, e.g. if functions from transform.H are
used:
\verbatim
angleOfAttack 5; // degs
angle #calc "-degToRad($angleOfAttack)";
#codeInclude "transform.H"
liftDir #calc "transform(Ry($angle), vector(0, 0, 1))";
dragDir #calc "transform(Ry($angle), vector(1, 0, 0))";
\endverbatim
Calculate the magnitude of the velocity and turbulent kinetic energy
where the velocity is looked-up from testCalc2:
\verbatim
magU #calc "mag($<vector>testCalc2!U)";
k #calc "1.5*magSqr(0.05*$<vector>{${FOAM_CASE}/testCalc2!U})";
\endverbatim
Example to generate a single block blockMeshDict for use with snappyHexMesh
with no redundant information:
\verbatim
min (-2.5 -1.2 -3.0); // Minimum coordinates of the block
max (2.5 1.2 3.0); // Maximum coordinates of the block
nCellsByL 33.3333; // Number of cells per unit length
// Calculate the number of cells in each block direction
nCells #calc
"Vector<label>($nCellsByL*($<vector>max - $<vector>min) + vector::one/2)";
// Generate the vertices using a boundBox
#codeInclude "boundBox.H"
vertices #calc "boundBox($<vector>min, $<vector>max).points()";
blocks
(
hex #calc "identityMap(8)" $nCells simpleGrading (1 1 1)
);
defaultPatch
{
type patch;
}
boundary
();
\endverbatim
Example of conditional with \#calc: showing the benefit of using verbatim
string:
\verbatim
#if (#calc "$fluid == \"waterAndSludge\" || $fluid == \"waterAndSand\"")
mixture multicomponentMixture;
#else
mixture pureMixture;
#endif
\endverbatim
same again but showing the benefit of using verbatim string:
\verbatim
#if (#calc #{$fluid == "waterAndSludge" || $fluid == "waterAndSand"#})
mixture multicomponentMixture;
#else
mixture pureMixture;
#endif
\endverbatim
See also
Foam::functionEntries::codeIncludeEntry
Foam::functionEntries::streamEntry
Foam::functionEntries::codeStream
SourceFiles
calcEntry.C
\*---------------------------------------------------------------------------*/
#ifndef calcEntry_H
#define calcEntry_H
#include "streamEntry.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionEntries
{
/*---------------------------------------------------------------------------*\
Class calcEntry Declaration
\*---------------------------------------------------------------------------*/
class calcEntry
:
public streamEntry
{
// Private Member Functions
//- Return the code string
static string codeString
(
const label index,
const dictionary& codeDict,
Istream&
);
public:
// Related types
//- Declare friendship with the calcEntry class
friend class codeBlockEntry;
//- Runtime type information
FunctionTypeName("#calc");
// Constructors
//- Copy construct
calcEntry(const calcEntry&) = default;
//- Clone
virtual autoPtr<entry> clone(const dictionary&) const
{
return autoPtr<entry>(new calcEntry(*this));
}
// Member Functions
//- Expand the functionEntry into the contextDict
virtual bool execute(dictionary& contextDict, Istream&)
{
NotImplemented;
return false;
}
//- Expand the functionEntry into the contextEntry
static bool execute
(
const dictionary& contextDict,
primitiveEntry& contextEntry,
Istream&
);
// Member Operators
//- Disallow default bitwise assignment
void operator=(const calcEntry&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionEntries
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|