File size: 8,077 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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/>.
\*---------------------------------------------------------------------------*/
#include "expressions.H"
#include "expressionDimensionSet.H"
#include "expressionDimensionedType.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace expression
{
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- A DimensionedField is expressionable
template<class Type, class GeoMesh, template<class> class PrimitiveField>
struct Expressionable<DimensionedField<Type, GeoMesh, PrimitiveField>>
:
public std::integral_constant<signed char, 1>
{};
//- Access to the dimensions of a DimensionedField is not expressionable. It
// returns a non-expressionable object (i.e., a dimensionSet).
template<class Type, class GeoMesh, template<class> class PrimitiveField>
struct Expressionable
<
DimensionedField<Type, GeoMesh, PrimitiveField>,
Arguments<dimensionSet>
>
:
public std::integral_constant<signed char, 0>
{};
//- Define access to the base primitive field of a DimensionedField. Note
// that expression::Value is specified as well as expression::Base. This is
// not important here, but it is important when accessing dimensioned
// constants in the same layer. The presence of expression::Value will ensure
// that their dimensions are removed and only their value is retained in the
// accessed expression.
template<class Type, class GeoMesh, template<class> class PrimitiveField>
struct Operate
<
DimensionedField<Type, GeoMesh, PrimitiveField>,
Arguments<Value, Base>
>
{
using type = const PrimitiveField<Type>&;
static type access
(
const DimensionedField<Type, GeoMesh, PrimitiveField>& f,
const Value&,
const Base&
)
{
return f.primitiveField();
}
};
//- Access the dimensions of a DimensionedField
template<class Type, class GeoMesh, template<class> class PrimitiveField>
struct Operate
<
DimensionedField<Type, GeoMesh, PrimitiveField>,
Arguments<dimensionSet>
>
{
using type = dimensionsOrVariableExponent;
static type access
(
const DimensionedField<Type, GeoMesh, PrimitiveField>& f,
const dimensionSet&
)
{
return type(f.dimensions());
}
};
//- Define the result types for a DimensionedField as the dimensioned
// equivalents of the primitive types
template<class Type, class GeoMesh, template<class> class PrimitiveField>
struct Result<DimensionedField<Type, GeoMesh, PrimitiveField>>
{
template<class Expression>
using primitiveType =
typename Result
<
PrimitiveField<Type>
>::template elementType
<
typename Operate
<
std::decay_t<Expression>,
Arguments<Value, Base>
>::type
>;
template<class Expression>
using elementType = dimensioned<primitiveType<Expression>>;
template<class Expression>
using type =
DimensionedField<primitiveType<Expression>, GeoMesh, Field>;
};
//- Implement a reduction of DimensionedField which reduces the primitive
// field (locally and then globally) and then combines the result with the
// name and dimensions of the expression to return a dimensioned type
template<class Type, class GeoMesh, template<class> class PrimitiveField>
struct Reduce<DimensionedField<Type, GeoMesh, PrimitiveField>>
{
// Global (parallel) reductions should be applied to the result by default
static const bool globalReduce = true;
template<class Op, class Expression>
static typename Result
<
DimensionedField<Type, GeoMesh, PrimitiveField>
>::template elementType<Expression> value
(
const Expression& e,
const bool globalReduce,
const label comm
)
{
return
typename Result
<
DimensionedField<Type, GeoMesh, PrimitiveField>
>::template elementType<Expression>
(
Op::name(name(e)),
access(e, NullObjectRef<dimensionSet>()),
Reduce<PrimitiveField<Type>>::template value<Op>
(
access(e, Value(), Base()),
globalReduce,
comm
)
);
}
template<class Expression>
static typename Result
<
DimensionedField<Type, GeoMesh, PrimitiveField>
>::template elementType<Expression> average
(
const Expression& e,
const bool globalReduce,
const label comm
)
{
return
typename Result
<
DimensionedField<Type, GeoMesh, PrimitiveField>
>::template elementType<Expression>
(
word("average(", name(e), ')'),
access(e, NullObjectRef<dimensionSet>()),
Reduce<PrimitiveField<Type>>::average
(
access(e, Value(), Base()),
globalReduce,
comm
)
);
}
template<class Expression, class WeightExpression>
static typename Result
<
DimensionedField<Type, GeoMesh, PrimitiveField>
>::template elementType<Expression> weightedAverage
(
const Expression& e,
const WeightExpression& we,
const bool globalReduce,
const label comm
)
{
return
typename Result
<
DimensionedField<Type, GeoMesh, PrimitiveField>
>::template elementType<Expression>
(
word("weightedAverage(", name(e), ',', name(we), ')'),
access(e, NullObjectRef<dimensionSet>()),
Reduce<PrimitiveField<Type>>::weightedAverage
(
access(e, Value(), Base()),
access(we, Value(), Base()),
globalReduce,
comm
)
);
}
};
//- The name of a DimensionedField is stored in its IOobject, so use this
// rather than the default string representation of the type and pointer
template<class Type, class GeoMesh, template<class> class PrimitiveField>
struct Name
<
DimensionedField<Type, GeoMesh, PrimitiveField>,
EnableIfExpressionable
<
DimensionedField<Type, GeoMesh, PrimitiveField>
>
>
{
static word& append
(
word& name,
const DimensionedField<Type, GeoMesh, PrimitiveField>& f
)
{
return name.append(f.name());
}
static const word& value
(
const DimensionedField<Type, GeoMesh, PrimitiveField>& f
)
{
return f.name();
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace expression
} // End namespace Foam
// ************************************************************************* //
|