File size: 6,968 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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/>.
Classes
Foam::expression::Reduce
Foam::expression::ReduceIterable
Description
Class which provides the ability to reduce an expression to a single value
using a binary operation (probably either min, max or sum). This must be
specialised for expressionable containers.
In the case of iterable containers that specialisation can inherit a
generic iterable implementation of reduction from the ReduceIterable class
(also defined in this file).
Non-iterable containers must implement their own reduction methods. This is
likely to be straightforward as non-iterable containers are typically just
wrappings or structured collections of iterable containers, so the
non-iterable implementation can just forward to the iterable implementation
and combine and return the result.
\*---------------------------------------------------------------------------*/
#ifndef expressionReduce_H
#define expressionReduce_H
#include "expressionResult.H"
#include "Pstream.H"
#include "Tuple2.H"
#include <numeric>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace expression
{
/*---------------------------------------------------------------------------*\
Class Reduce Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
struct Reduce
{
static const bool globalReduce = false;
template<class Op, class Value>
static const Value& value
(
const Value& x,
const bool globalReduce = false,
const label comm = UPstream::worldComm
)
{
return x;
}
};
/*---------------------------------------------------------------------------*\
Class ReduceIterable Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
struct ReduceIterable;
template<template<class ...> class Container, class Type, class ... Args>
struct ReduceIterable<Container<Type, Args ...>>
{
static const bool globalReduce = false;
template<class Op, class Expression>
static typename ResultIterable<Container<Type, Args ...>>::
template elementType<Expression> value
(
const Expression& e,
const bool globalReduce = false,
const label comm = UPstream::worldComm
)
{
typedef typename ResultIterable<Container<Type, Args ...>>::template
operateType<Expression> operateType;
typedef typename ResultIterable<Container<Type, Args ...>>::template
elementType<Expression> elementType;
auto x =
std::accumulate
(
begin(e),
end(e),
Op::template identity<elementType>(),
[](const elementType& x, const operateType& y)
{
return Op::value
(
x,
Reduce<Type>::template value<Op>
(
y,
false,
UPstream::worldComm
)
);
}
);
if (globalReduce)
{
reduce(x, Op(), Pstream::msgType(), comm);
}
return x;
}
template<class Expression>
static typename ResultIterable<Container<Type, Args ...>>::
template elementType<Expression> average
(
const Expression& e,
const bool globalReduce,
const label comm = UPstream::worldComm
)
{
const Size::type n = getFirst<Size>(e);
if (globalReduce)
{
auto s = value<sumOp>(e, false);
Tuple2<decltype(s), Size::type> sn(s, n);
reduce(sn, sum2Op(), Pstream::msgType(), comm);
if (sn.second() > 0)
{
return sn.first()/sn.second();
}
else
{
WarningInFunction
<< "empty field, returning zero" << endl;
return ElementType<Expression>(Zero);
}
}
else
{
if (n)
{
return value<sumOp>(e, false)/n;
}
else
{
WarningInFunction
<< "empty field, returning zero" << endl;
return ElementType<Expression>(Zero);
}
}
}
template<class Expression, class WeightExpression>
static typename ResultIterable<Container<Type, Args ...>>::
template elementType<Expression> weightedAverage
(
const Expression& e,
const WeightExpression& we,
const bool globalReduce,
const label comm = UPstream::worldComm
)
{
auto ws = value<sumOp>(we*e, false);
auto w = value<sumOp>(we, false);
if (globalReduce)
{
Tuple2<decltype(ws), decltype(w)> wsw(ws, w);
reduce(wsw, sum2Op(), Pstream::msgType(), comm);
return wsw.first()/wsw.second();
}
else
{
return ws/w;
}
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace expression
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
template<class Expression>
using ReduceType = typename expression::Reduce
<
typename expression::AllContainers<Expression>::type
>;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|