File size: 17,199 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 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 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/>.
Description
Unary and binary functions and operators used by the expression
templating system
\*---------------------------------------------------------------------------*/
#ifndef expressions_H
#define expressions_H
#include "expressionFunctor.H"
#include "expressionReduce.H"
#include "PstreamReduceOps.H"
#include "expressionEval.H"
#include "UnaryExpression.H"
#include "BinaryExpression.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Define a unary function or operator given the global function or operator
// name and the operator class that it uses
#define UnaryFunction_(FUNC, Func, Op) \
FUNC(Func, Op, const X&, const X& x, x) \
FUNC(Func, Op, const X&, X& x, x) \
FUNC(Func, Op, X, X&& x, std::move(x)) \
FUNC(Func, Op, const X&, const tmp<X>& x, x) \
FUNC(Func, Op, const X&, tmp<X>& x, x) \
FUNC(Func, Op, const X&, tmp<X>&& x, x)
#define UnaryFunctionTemplate(Func, Op, XPar, XArg, XVar) \
template \
< \
class X, \
class = EnableIfExpressionable<UnaryExpression<X, Op>> \
> \
UnaryExpression<XPar, Op> Func(XArg) \
{ \
return UnaryExpression<XPar, Op>(XVar); \
} \
#define UnaryEagerFunctionTemplate(Func, Op, XPar, XArg, XVar) \
\
UnaryFunctionTemplate(Func##_, Op, XPar, XArg, XVar) \
\
template \
< \
class X, \
class = EnableIfExpressionable<UnaryExpression<X, Op>> \
> \
tmp<ResultType<UnaryExpression<XPar, Op>>> Func(XArg) \
{ \
return eval(Func##_(Eval<XPar>::eval(XVar))); \
} \
#define UnaryOperator(OpSym, Func) \
UnaryFunction_(UnaryFunctionTemplate, operator OpSym, Func##Op)
#define UnaryFunction(Func) \
UnaryFunction_(UnaryFunctionTemplate, Func, Func##Op)
#define UnaryEagerFunction(Func) \
UnaryFunction_(UnaryEagerFunctionTemplate, Func, Func##Op)
#define UnaryOp(Func) \
struct Func##Op \
{ \
static inline const char* prefix = #Func"("; \
static inline const char postfix = ')'; \
\
static const signed char precedence = \
expression::Operation<void>::precedence; \
\
template<class Type> \
static auto value(const Type& x) \
{ \
return Func(x); \
} \
};
#define UnaryOpFunction(Func) \
UnaryOp(Func) \
UnaryFunction(Func)
#define UnaryOpEagerFunction(Func) \
UnaryOp(Func) \
UnaryEagerFunction(Func)
// Promotion operator (i.e., unary plus). Has no effect. Just facilitates
// expressions with plus signs added for clarity.
UnaryOperator(+, promote)
// Negation operator (i.e., unary minus). Changes the sign of the operand.
UnaryOperator(-, negate)
UnaryFunction(sqr)
UnaryFunction(mag)
UnaryFunction(magSqr)
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Define unary reduction functions
#define UnaryReduction_(Func, gFunc, Op) \
\
template<class Expression, class = EnableIfExpressionable<Expression>> \
ElementType<Expression> Func \
( \
const Expression& e, \
const bool globalReduce = ReduceType<Expression>::globalReduce, \
const label comm = UPstream::worldComm \
) \
{ \
return ReduceType<Expression>::template value<Op> \
( \
e, globalReduce, comm \
); \
} \
\
template<class Expression, class = EnableIfExpressionable<Expression>> \
ElementType<Expression> Func(const tmp<Expression>& te) \
{ \
auto x = Func(te()); \
te.clear(); \
return x; \
} \
\
template<class Expression, class = EnableIfExpressionable<Expression>> \
ElementType<Expression> gFunc \
( \
const Expression& e, \
const label comm = UPstream::worldComm \
) \
{ \
return Func(e, true, comm); \
} \
\
template<class Expression, class = EnableIfExpressionable<Expression>> \
ElementType<Expression> gFunc(const tmp<Expression>& te) \
{ \
auto x = gFunc(te()); \
te.clear(); \
return x; \
}
#define UnaryReduction(Func, gFunc) \
UnaryReduction_(Func, gFunc, Func##Op)
UnaryReduction(sum, gSum);
UnaryReduction(max, gMax);
UnaryReduction(min, gMin);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Define unary average and gAverage functions
template<class Expression, class = EnableIfExpressionable<Expression>>
ElementType<Expression> average
(
const Expression& e,
const bool globalReduce = ReduceType<Expression>::globalReduce,
const label comm = UPstream::worldComm
)
{
return ReduceType<Expression>::average(e, globalReduce, comm);
}
template<class Expression, class = EnableIfExpressionable<Expression>>
ElementType<Expression> average(const tmp<Expression>& te)
{
auto x = average(te());
te.clear();
return x;
}
template<class Expression, class = EnableIfExpressionable<Expression>>
ElementType<Expression> gAverage
(
const Expression& e,
const label comm = UPstream::worldComm
)
{
return average(e, true, comm);
}
template<class Expression, class = EnableIfExpressionable<Expression>>
ElementType<Expression> gAverage
(
const tmp<Expression>& te,
const label comm = UPstream::worldComm
)
{
auto x = gAverage(te());
te.clear();
return x;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Weighted average
template
<
class Expression,
class WeightExpression,
class = EnableIfExpressionable<Expression>
>
ElementType<Expression> weightedAverage
(
const Expression& e,
const WeightExpression& we,
const bool globalReduce = ReduceType<Expression>::globalReduce,
const label comm = UPstream::worldComm
)
{
return ReduceType<Expression>::weightedAverage
(
e,
we,
globalReduce,
comm
);
}
template
<
class Expression,
class WeightExpression,
class = EnableIfExpressionable<Expression>
>
ElementType<Expression> weightedAverage
(
const tmp<Expression>& te,
const WeightExpression& we
)
{
auto x = weightedAverage(te(), we);
te.clear();
return x;
}
template
<
class Expression,
class WeightExpression,
class = EnableIfExpressionable<Expression>
>
ElementType<Expression> gWeightedAverage
(
const Expression& e,
const WeightExpression& we,
const label comm = UPstream::worldComm
)
{
return weightedAverage(e, we, true, comm);
}
template
<
class Expression,
class WeightExpression,
class = EnableIfExpressionable<Expression>
>
ElementType<Expression> gWeightedAverage
(
const tmp<Expression>& te,
const WeightExpression& we,
const label comm = UPstream::worldComm
)
{
auto x = gWeightedAverage(te(), we);
te.clear();
return x;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Define a binary function or operator given the global function or operator
// name and the operator class that it uses
#define BinaryFunction__(FUNC, Func, Op, APar, AArg, AVar) \
FUNC(Func, Op, APar, AArg, AVar, const B&, const B& b, b) \
FUNC(Func, Op, APar, AArg, AVar, const B&, B& b, b) \
FUNC(Func, Op, APar, AArg, AVar, B, B&& b, std::move(b)) \
FUNC(Func, Op, APar, AArg, AVar, const B&, const tmp<B>& b, b) \
FUNC(Func, Op, APar, AArg, AVar, const B&, tmp<B>& b, b) \
FUNC(Func, Op, APar, AArg, AVar, const B&, tmp<B>&& b, b)
#define BinaryFunction_(FUNC, Func, Op) \
BinaryFunction__(FUNC, Func, Op, const A&, const A& a, a) \
BinaryFunction__(FUNC, Func, Op, const A&, A& a, a) \
BinaryFunction__(FUNC, Func, Op, A, A&& a, std::move(a)) \
BinaryFunction__(FUNC, Func, Op, const A&, const tmp<A>& a, a) \
BinaryFunction__(FUNC, Func, Op, const A&, tmp<A>& a, a) \
BinaryFunction__(FUNC, Func, Op, const A&, tmp<A>&& a, a)
#define BinaryFunctionTemplate(Func, Op, APar, AArg, AVar, BPar, BArg, BVar) \
template \
< \
class A, \
class B, \
class = EnableIfExpressionable<BinaryExpression<A, B, Op>> \
> \
BinaryExpression<APar, BPar, Op> Func(AArg, BArg) \
{ \
return BinaryExpression<APar, BPar, Op>(AVar, BVar); \
} \
#define BinaryEagerFunctionTemplate( \
Func, Op, APar, AArg, AVar, BPar, BArg, BVar) \
\
BinaryFunctionTemplate(Func##_, Op, APar, AArg, AVar, BPar, BArg, BVar) \
\
template \
< \
class A, \
class B, \
class = EnableIfExpressionable<BinaryExpression<A, B, Op>> \
> \
tmp<ResultType<BinaryExpression<APar, BPar, Op>>> Func(AArg, BArg) \
{ \
return eval(Func##_(Eval<APar>::eval(AVar), Eval<BPar>::eval(BVar))); \
} \
#define BinaryOperator(OpSym, Func) \
BinaryFunction_(BinaryFunctionTemplate, operator OpSym, Func##Op)
#define BinaryFunction(Func) \
BinaryFunction_(BinaryFunctionTemplate, Func, Func##Op)
#define BinaryEagerFunction(Func) \
BinaryFunction_(BinaryEagerFunctionTemplate, Func, Func##Op)
// Addition operator and sum function
BinaryOperator(+, add);
// Subtraction operator
BinaryOperator(-, subtract);
// Multiplication and/or outer-product operator
BinaryOperator(*, multiply);
// Division operator
BinaryOperator(/, divide);
// Inner product (dot) operator
BinaryOperator(&, inner);
// Cross product operator
BinaryOperator(^, cross);
// Maximum functions
BinaryFunction(max);
// Minimum function
BinaryFunction(min);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|