File size: 6,831 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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 vector functions and operators used by the expression
templating system
\*---------------------------------------------------------------------------*/
#ifndef vectorExpressions_H
#define vectorExpressions_H
#include "vector.H"
#include "expressions.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Unary vector functions
UnaryFunction(cmptMax)
UnaryFunction(cmptMin)
UnaryFunction(cmptAv)
UnaryFunction(cmptMag)
UnaryOpFunction(normalised)
UnaryOpFunction(perpendicular)
/*---------------------------------------------------------------------------*\
Class powProductOp Declaration
\*---------------------------------------------------------------------------*/
// Powers of a Form
// Equivalent to outer-products between the Form and itself
template<direction r>
struct powProductOp;
// Form^0 = 1.0
template<>
struct powProductOp<0>
{
static inline const char* prefix = "pow<0>(";
static inline const char postfix = ')';
static const signed char precedence =
expression::Operation<void>::precedence;
static const bool associative = false;
template<class Form, class Cmpt, direction Ncmpts>
static typename powProduct<Form, 0>::type value
(
const VectorSpace<Form, Cmpt, Ncmpts>& v
)
{
return 1.0;
}
static const dimensionSet& value(const dimensionSet&)
{
return dimless;
}
};
// Form^1 = Form
template<>
struct powProductOp<1>
{
static inline const char* prefix = "pow<1>(";
static inline const char postfix = ')';
static const signed char precedence =
expression::Operation<void>::precedence;
static const bool associative = false;
template<class Form, class Cmpt, direction Ncmpts>
static typename powProduct<Form, 1>::type value
(
const VectorSpace<Form, Cmpt, Ncmpts>& v
)
{
return static_cast<const Form&>(v);
}
static dimensionSet value(const dimensionSet& a)
{
return a;
}
};
// Form^2 = sqr(Form)
template<>
struct powProductOp<2>
{
static inline const char* prefix = "pow<2>(";
static inline const char postfix = ')';
static const signed char precedence =
expression::Operation<void>::precedence;
static const bool associative = false;
template<class Form, class Cmpt, direction Ncmpts>
static typename powProduct<Form, 2>::type value
(
const VectorSpace<Form, Cmpt, Ncmpts>& v
)
{
return sqr(static_cast<const Form&>(v));
}
static dimensionSet value(const dimensionSet& a)
{
return sqr(a);
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Pow product unary function
template<direction r, class Form, class Cmpt, direction Ncmpts>
typename powProduct<Form, r>::type pow
(
const VectorSpace<Form, Cmpt, Ncmpts>& v
)
{
return powProductOp<r>::value(static_cast<const Form&>(v));
}
template<class Type, direction r>
dimensioned<typename powProduct<Type, r>::type> pow
(
const dimensioned<Type>& dt
)
{
return dimensioned<typename powProduct<Type, r>::type>
(
word("pow(", dt.name(), ',', name(r), ')'),
pow(dt.dimensions(), r),
powProductOp<r>::value(dt.value())
);
}
#define UnaryPowProduct(XPar, XArg, XVar) \
template \
< \
direction r, \
class X, \
class = EnableIfExpressionable<UnaryExpression<X, powProductOp<r>>> \
> \
UnaryExpression<XPar, powProductOp<r>> pow(XArg) \
{ \
return UnaryExpression<XPar, powProductOp<r>>(XVar); \
} \
UnaryPowProduct(const X&, const X& x, x)
UnaryPowProduct(const X&, X& x, x)
UnaryPowProduct(X, X&& x, std::move(x))
UnaryPowProduct(const X&, const tmp<X>& x, x)
UnaryPowProduct(const X&, tmp<X>& x, x)
UnaryPowProduct(const X&, tmp<X>&& x, x)
#undef UnaryPowProduct
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Binary vector functions
BinaryFunction(cmptMultiply);
BinaryFunction(cmptDivide);
/*---------------------------------------------------------------------------*\
Class componentOp Declaration
\*---------------------------------------------------------------------------*/
struct componentOp
{
static inline const char* prefix = "component(";
static inline const char infix = ',';
static inline const char postfix = ')';
static const signed char precedence =
expression::Operation<void>::precedence;
static const bool associative = false;
template<class VSType, class Dtype>
static auto value(const VSType& vs, const Dtype& d)
{
return component(vs, d);
}
};
BinaryFunction(component);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|