File size: 7,682 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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 scalar functions and operators used by the expression
templating system
\*---------------------------------------------------------------------------*/
#ifndef scalarExpressions_H
#define scalarExpressions_H
#include "scalar.H"
#include "expressions.H"
#include "dimensionSet.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class powOp Declaration
\*---------------------------------------------------------------------------*/
struct powOp
{
static inline const char* prefix = "pow(";
static inline const char infix = ',';
static inline const char postfix = ')';
static const signed char precedence =
expression::Operation<void>::precedence;
static const bool associative = false;
static scalar value(const scalar a, const float b)
{
return pow(a, b);
}
static scalar value(const scalar a, const double b)
{
return pow(a, b);
}
static scalar value(const scalar a, const long double b)
{
return pow(a, b);
}
static scalar value(const scalar a, const int32_t b)
{
return integerPow(a, b);
}
static scalar value(const scalar a, const int64_t b)
{
return integerPow(a, b);
}
template<class A, class B>
static auto value(const A& a, const B& b)
{
return pow(a, b);
}
};
/*---------------------------------------------------------------------------*\
Class integerPowOp Declaration
\*---------------------------------------------------------------------------*/
struct integerPowOp
{
static inline const char* prefix = "integerPow(";
static inline const char infix = ',';
static inline const char postfix = ')';
static const signed char precedence =
expression::Operation<void>::precedence;
static const bool associative = false;
static scalar value(const scalar a, const int32_t b)
{
return integerPow(a, b);
}
static scalar value(const scalar a, const int64_t b)
{
return integerPow(a, b);
}
template<class A, class B>
static auto value(const A& a, const B& b)
{
return pow(a, b);
}
};
/*---------------------------------------------------------------------------*\
Class integerRootOp Declaration
\*---------------------------------------------------------------------------*/
struct integerRootOp
{
static inline const char* prefix = "integerRoot(";
static inline const char infix = ',';
static inline const char postfix = ')';
static const signed char precedence =
expression::Operation<void>::precedence;
static const bool associative = false;
static scalar value(const scalar a, const int32_t b)
{
return integerRoot(a, b);
}
static scalar value(const scalar a, const int64_t b)
{
return integerRoot(a, b);
}
template<class A, class B>
static auto value(const A& a, const B& b)
{
return root(a, b);
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Unary scalar functions
UnaryOpFunction(pow3)
UnaryOpFunction(pow4)
UnaryOpFunction(pow5)
UnaryOpFunction(pow6)
UnaryOpFunction(pow025)
UnaryOpFunction(sqrt)
UnaryOpFunction(sign)
UnaryOpFunction(pos)
UnaryOpFunction(pos0)
UnaryOpFunction(neg)
UnaryOpFunction(neg0)
UnaryOpFunction(posPart)
UnaryOpFunction(negPart)
UnaryOpFunction(exp)
UnaryOpFunction(log)
UnaryOpFunction(log10)
UnaryOpFunction(sin)
UnaryOpFunction(cos)
UnaryOpFunction(tan)
UnaryOpFunction(asin)
UnaryOpFunction(acos)
UnaryOpFunction(atan)
// Expensive unary scalar functions
UnaryOpFunction(cbrt)
UnaryOpFunction(sinh)
UnaryOpFunction(cosh)
UnaryOpFunction(tanh)
UnaryOpFunction(asinh)
UnaryOpFunction(acosh)
UnaryOpFunction(atanh)
UnaryOpFunction(erf)
UnaryOpFunction(erfc)
UnaryOpFunction(lgamma)
UnaryOpFunction(j0)
UnaryOpFunction(j1)
UnaryOpFunction(y0)
UnaryOpFunction(y1)
BinaryFunction(stabilise);
BinaryFunction(integerPow);
BinaryFunction(integerRoot);
// Eager evaluate pow to avoid interference with loop optimisation
// Benefit demonstrated on x86 processors with sse2 and avx512
BinaryEagerFunction(pow);
/*---------------------------------------------------------------------------*\
Class atan2Op Declaration
\*---------------------------------------------------------------------------*/
struct atan2Op
{
static inline const char* prefix = "atan2(";
static inline const char infix = ',';
static inline const char postfix = ')';
static const signed char precedence =
expression::Operation<void>::precedence;
static const bool associative = false;
static scalar value(const scalar a, const scalar b)
{
return atan2(a, b);
}
};
// Atan2 function
BinaryFunction(atan2);
/*---------------------------------------------------------------------------*\
Class jnOp Declaration
\*---------------------------------------------------------------------------*/
struct jnOp
{
static inline const char* prefix = "jn(";
static inline const char infix = ',';
static inline const char postfix = ')';
static const signed char precedence =
expression::Operation<void>::precedence;
static const bool associative = false;
static scalar value(const int n, const scalar s)
{
return jn(n, s);
}
};
// Bessel function jn
BinaryFunction(jn);
/*---------------------------------------------------------------------------*\
Class ynOp Declaration
\*---------------------------------------------------------------------------*/
struct ynOp
{
static inline const char* prefix = "yn(";
static inline const char infix = ',';
static inline const char postfix = ')';
static const signed char precedence =
expression::Operation<void>::precedence;
static const bool associative = false;
static scalar value(const int n, const scalar s)
{
return yn(n, s);
}
};
// Bessel function yn
BinaryFunction(yn);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|