File size: 16,880 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 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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/>.
Class
Foam::BinaryExpression
Description
Binary expression class. Wraps a two sub-types which may be other
expressions or expressionable containers or constant values. Applies a
binary operation to the output of these sub-expressions.
Note the specialisation of this class. This stores a sub-expression if it
is provided as an r-value, thereby ensuring that it remains in scope as
long as the outer expression does. And it takes a constant reference if a
sub-expression is provided as a reference, which ensures that copies are
not made unnecessarily.
\*---------------------------------------------------------------------------*/
#ifndef BinaryExpression_H
#define BinaryExpression_H
#include "expressionContainers.H"
#include "expressionOperate.H"
#include "expressionName.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class BinaryExpression Declaration
\*---------------------------------------------------------------------------*/
template<class A, class B, class Op>
struct BinaryExpression
:
public expression::expression
{
A a;
B b;
BinaryExpression(A&& a, B&& b)
:
a(std::move(a)),
b(std::move(b))
{}
};
template<class A, class B, class Op>
class BinaryExpression<A, const B&, Op>
:
public expression::expression
{
const ConditionalIfBaseOf<refCount, B, tmp<B>, nil> tb_;
public:
A a;
const B& b;
BinaryExpression(A&& a, const B& b)
:
a(std::move(a)),
b(b)
{}
BinaryExpression(A&& a, const tmp<B>& tb)
:
tb_(tb, true),
a(std::move(a)),
b(tb_())
{
tb.clear();
}
};
template<class A, class B, class Op>
class BinaryExpression<const A&, B, Op>
:
public expression::expression
{
const ConditionalIfBaseOf<refCount, A, tmp<A>, nil> ta_;
public:
const A& a;
B b;
BinaryExpression(const A& a, B&& b)
:
a(a),
b(std::move(b))
{}
BinaryExpression(const tmp<A>& ta, B&& b)
:
ta_(ta, true),
a(ta_()),
b(std::move(b))
{
ta.clear();
}
};
template<class A, class B, class Op>
class BinaryExpression<const A&, const B&, Op>
:
public expression::expression
{
const ConditionalIfBaseOf<refCount, A, tmp<A>, nil> ta_;
const ConditionalIfBaseOf<refCount, B, tmp<B>, nil> tb_;
public:
const A& a;
const B& b;
BinaryExpression(const A& a, const B& b)
:
a(a),
b(b)
{}
BinaryExpression(const tmp<A>& ta, const B& b)
:
ta_(ta, true),
a(ta_()),
b(b)
{
ta.clear();
}
BinaryExpression(const A& a, const tmp<B>& tb)
:
tb_(tb, true),
a(a),
b(tb_())
{
tb.clear();
}
BinaryExpression(const tmp<A>& ta, const tmp<B>& tb)
:
ta_(ta, true),
tb_(tb, true),
a(ta_()),
b(tb_())
{
ta.clear();
tb.clear();
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace expression
{
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- Helper type definitions and functions for forwarding the sub-expressions as
// arguments. If the type is a binary expression, then forward the
// sub-expression, otherwise forward the type itself.
template<class Type>
struct ArgA
{
using type = Type;
};
template<class Type>
struct ArgB
{
using type = Type;
};
template<class A, class B, class Op>
struct ArgA<BinaryExpression<A, B, Op>>
{
using type = A;
};
template<class A, class B, class Op>
struct ArgB<BinaryExpression<A, B, Op>>
{
using type = B;
};
template<class Type>
using ArgAType = typename ArgA<Type>::type;
template<class Type>
using ArgBType = typename ArgB<Type>::type;
template<class Type>
const Type& argA(const Type& t)
{
return t;
}
template<class Type>
const Type& argB(const Type& t)
{
return t;
}
template<class Type>
Type& argA(Type& t)
{
return t;
}
template<class Type>
Type& argB(Type& t)
{
return t;
}
template<class A, class B, class Op>
const A& argA(const BinaryExpression<A, B, Op>& e)
{
return e.a;
}
template<class A, class B, class Op>
const B& argB(const BinaryExpression<A, B, Op>& e)
{
return e.b;
}
template<class A, class B, class Op>
A& argA(BinaryExpression<A, B, Op>& e)
{
return e.a;
}
template<class A, class B, class Op>
B& argB(BinaryExpression<A, B, Op>& e)
{
return e.b;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- Specialise Expressionable for the binary expression. A binary expression is
// considered expressionable if either of it's sub-expressions are
// expressionable.
template<class A, class B, class Op>
struct Expressionable<BinaryExpression<A, B, Op>>
:
public std::conditional
<
(
Expressionable<std::decay_t<A>>::value < 0
|| Expressionable<std::decay_t<B>>::value < 0
),
notExpressionable,
typename std::conditional
<
(
Expressionable<std::decay_t<A>>::value
> Expressionable<std::decay_t<B>>::value
),
Expressionable<std::decay_t<A>>,
Expressionable<std::decay_t<B>>
>::type
>::type
{};
template<class A, class B, class Op, class ... Args>
struct Expressionable<BinaryExpression<A, B, Op>, Arguments<Args ...>>
:
public std::conditional
<
(
Expressionable
<
std::decay_t<A>,
Arguments<ArgAType<Args> ...>
>::value
> Expressionable
<
std::decay_t<B>,
Arguments<ArgBType<Args> ...>
>::value
),
Expressionable
<
std::decay_t<A>,
Arguments<ArgAType<Args> ...>
>,
Expressionable
<
std::decay_t<B>,
Arguments<ArgBType<Args> ...>
>
>::type
{};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- Specialise AllContainers and TypeContainers for the binary expression so
// that access is forwarded to the sub-expressions
template<class A, class B, class Op>
struct AllContainers
<
BinaryExpression<A, B, Op>,
EnableIfExpressionable<BinaryExpression<A, B, Op>>
>
{
using allContainersA = AllContainers<std::decay_t<A>>;
using allContainersB = AllContainers<std::decay_t<B>>;
static const unsigned n = allContainersA::n + allContainersB::n;
using type =
typename std::conditional
<
(
Expressionable<typename allContainersA::type>::value
> Expressionable<typename allContainersB::type>::value
),
typename allContainersA::type,
typename allContainersB::type
>::type;
template<class Property, unsigned I>
static std::enable_if_t
<
(I < allContainersA::n),
typename Property::type
> get
(
const BinaryExpression<A, B, Op>& e
)
{
return allContainersA::template get<Property, I>(e.a);
}
template<class Property, unsigned I>
static std::enable_if_t
<
(I >= allContainersA::n),
typename Property::type
> get
(
const BinaryExpression<A, B, Op>& e
)
{
return allContainersB::template get<Property, I - allContainersA::n>
(
e.b
);
}
template<class Property, unsigned I, unsigned N>
static void get
(
const BinaryExpression<A, B, Op>& e,
FixedList<typename Property::type, N>& result
)
{
allContainersA::template get<Property, I>(e.a, result);
allContainersB::template get<Property, allContainersA::n + I>
(
e.b,
result
);
}
};
template<class A, class B, class Op, class Type>
struct TypeContainers
<
BinaryExpression<A, B, Op>,
Type,
EnableIfNotBaseOf<Type, BinaryExpression<A, B, Op>>
>
{
using typeContainersA = TypeContainers<std::decay_t<A>, Type>;
using typeContainersB = TypeContainers<std::decay_t<B>, Type>;
static const unsigned n = typeContainersA::n + typeContainersB::n;
template<class Property, unsigned I>
static std::enable_if_t
<
(I < typeContainersA::n),
typename Property::type
> get
(
const BinaryExpression<A, B, Op>& e
)
{
return typeContainersA::template get<Property, I>(e.a);
}
template<class Property, unsigned I>
static std::enable_if_t
<
(I >= typeContainersA::n),
typename Property::type
> get
(
const BinaryExpression<A, B, Op>& e
)
{
return typeContainersB::template get<Property, I - typeContainersA::n>
(
e.b
);
}
template<class Property, unsigned I, unsigned N>
static void get
(
const BinaryExpression<A, B, Op>& e,
FixedList<typename Property::type, N>& result
)
{
typeContainersA::template get<Property, I>(e.a, result);
typeContainersB::template get<Property, typeContainersA::n + I>
(
e.b,
result
);
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- Specialise Operate for the binary expression so that operations are
// forwarded to the sub-expressions.
//
// Note different specialisations for expressionable and non-expressionable
// binary expressions. The non-expressionable specialisation access returns a
// value as calculated by the operation, whilst the expressionable
// specialisation returns another expression containing the accessed
// sub-types. In this way, the expressions can be nested, with each level
// generating an appropriate type to which an element of an expressionable
// container (container of containers, etc...) can be assigned.
template<class A, class B, class Op, class ... Args>
struct BinaryExpressionOperateBase
{
using operateA =
Operate<std::decay_t<A>, Arguments<ArgAType<Args> ...>>;
using operateB =
Operate<std::decay_t<B>, Arguments<ArgBType<Args> ...>>;
struct compareA
{
static bool compare
(
const BinaryExpression<A, B, Op>& e,
const Args& ... args
)
{
return operateA::compare(e.a, argA(args) ...);
}
};
struct compareB
{
static bool compare
(
const BinaryExpression<A, B, Op>& e,
const Args& ... args
)
{
return operateB::compare(e.b, argB(args) ...);
}
};
static bool compare
(
const BinaryExpression<A, B, Op>& e,
const Args& ... args
)
{
return
std::conditional
<
(Expressionable<std::decay_t<A>>::value > 0),
compareA,
compareB
>::type::compare(e, args ...);
}
static void advance
(
const BinaryExpression<A, B, Op>& e,
Args& ... args
)
{
operateA::advance(e.a, argA(args) ...);
operateB::advance(e.b, argB(args) ...);
}
};
template<class A, class B, class Op, class ... Args>
struct Operate
<
BinaryExpression<A, B, Op>,
Arguments<Args ...>,
EnableIfNotExpressionable<BinaryExpression<A, B, Op>, Args ...>
>
:
public BinaryExpressionOperateBase<A, B, Op, Args ...>
{
using operateA =
typename BinaryExpressionOperateBase<A, B, Op, Args ...>::operateA;
using operateB =
typename BinaryExpressionOperateBase<A, B, Op, Args ...>::operateB;
using type =
decltype
(
Op::value
(
std::declval<typename operateA::type>(),
std::declval<typename operateB::type>()
)
);
static type access
(
const BinaryExpression<A, B, Op>& e,
const Args& ... args
)
{
return
Op::value
(
operateA::access(e.a, argA(args) ...),
operateB::access(e.b, argB(args) ...)
);
}
};
template<class A, class B, class Op, class ... Args>
struct Operate
<
BinaryExpression<A, B, Op>,
Arguments<Args ...>,
EnableIfExpressionable<BinaryExpression<A, B, Op>, Args ...>
>
:
public BinaryExpressionOperateBase<A, B, Op, Args ...>
{
using operateA =
typename BinaryExpressionOperateBase<A, B, Op, Args ...>::operateA;
using operateB =
typename BinaryExpressionOperateBase<A, B, Op, Args ...>::operateB;
using type =
BinaryExpression
<
typename operateA::type,
typename operateB::type,
Op
>;
static type access
(
const BinaryExpression<A, B, Op>& e,
const Args& ... args
)
{
return
type
(
operateA::access(e.a, argA(args) ...),
operateB::access(e.b, argB(args) ...)
);
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- Specialise Operation for the binary expression. Take the base operator type
// and precedence from the operation parameter.
template<class A, class B, class Op>
struct Operation<BinaryExpression<A, B, Op>>
{
using type = Op;
static const signed char precedence = Op::precedence;
};
//- Specialise Name for the binary expression. Wraps the names of the
// sub-expressions in the name of the operation, adding brackets if the
// relative precedence of the operations requires it.
template<class A, class B, class Op>
struct Name
<
BinaryExpression<A, B, Op>,
EnableIfExpressionable<BinaryExpression<A, B, Op>>
>
{
using nameA = Name<std::decay_t<A>>;
using nameB = Name<std::decay_t<B>>;
static word& append(word& name, const BinaryExpression<A, B, Op>& e)
{
name.append(Op::prefix);
if
(
Op::precedence != Operation<void>::precedence
&& Operation<A>::precedence != Operation<void>::precedence
&& Op::precedence > Operation<A>::precedence
)
{
name.append('(');
nameA::append(name, e.a);
name.append(')');
}
else
{
nameA::append(name, e.a);
}
name.append(Op::infix);
if
(
Op::precedence != Operation<void>::precedence
&& Operation<B>::precedence != Operation<void>::precedence
&& (
Op::precedence > Operation<B>::precedence
|| (
Op::precedence == Operation<B>::precedence
&& !Op::associative
)
)
)
{
name.append('(');
nameB::append(name, e.b);
name.append(')');
}
else
{
nameB::append(name, e.b);
}
return name.append(Op::postfix);
}
static word value(const BinaryExpression<A, B, Op>& e)
{
word name;
return append(name, e);
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace expression
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|