FieldFunctions.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #define TEMPLATE template<class Type>
27 #include "FieldFunctionsM.H"
28 #include "UPstream.H"
29 
30 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
31 
32 namespace Foam
33 {
34 
35 // * * * * * * * * * * * * * * * Global Functions * * * * * * * * * * * * * //
36 
37 template<class Type>
38 void component
39 (
40  Field<typename Field<Type>::cmptType>& res,
41  const UList<Type>& f,
42  const direction d
43 );
44 
45 
46 template<class Type>
47 void T(Field<Type>& res, const UList<Type>& f);
48 
49 
50 template<class Type, direction r>
51 void pow
52 (
53  Field<typename powProduct<Type, r>::type>& res,
54  const UList<Type>& vf
55 );
56 
57 
58 template<class Type, direction r>
59 tmp<Field<typename powProduct<Type, r>::type>>
60 pow
61 (
62  const UList<Type>& f,
63  typename powProduct<Type, r>::type
64  = pTraits<typename powProduct<Type, r>::type>::zero
65 );
66 
67 template<class Type, direction r>
68 tmp<Field<typename powProduct<Type, r>::type>>
69 pow
70 (
71  const tmp<Field<Type>>& tf,
72  typename powProduct<Type, r>::type
73  = pTraits<typename powProduct<Type, r>::type>::zero
74 );
75 
76 
77 template<class Type>
78 void sqr
79 (
80  Field<typename outerProduct<Type, Type>::type>& res,
81  const UList<Type>& vf
82 );
83 
84 template<class Type>
85 tmp<Field<typename outerProduct<Type, Type>::type>>
86 sqr(const UList<Type>& f);
87 
88 template<class Type>
89 tmp<Field<typename outerProduct<Type, Type>::type>>
90 sqr(const tmp<Field<Type>>& tf);
91 
92 
93 template<class Type>
94 void magSqr(Field<scalar>& res, const UList<Type>& f);
95 
96 template<class Type>
97 tmp<Field<scalar>> magSqr(const UList<Type>& f);
98 
99 template<class Type>
100 tmp<Field<scalar>> magSqr(const tmp<Field<Type>>& tf);
101 
102 
103 template<class Type>
104 void mag(Field<scalar>& res, const UList<Type>& f);
105 
106 template<class Type>
107 tmp<Field<scalar>> mag(const UList<Type>& f);
108 
109 template<class Type>
110 tmp<Field<scalar>> mag(const tmp<Field<Type>>& tf);
111 
112 
113 template<class Type>
114 void cmptMax(Field<typename Field<Type>::cmptType>& res, const UList<Type>& f);
115 
116 template<class Type>
117 tmp<Field<typename Field<Type>::cmptType>> cmptMax(const UList<Type>& f);
118 
119 template<class Type>
120 tmp<Field<typename Field<Type>::cmptType>>
121 cmptMax(const tmp<Field<Type>>& tf);
122 
123 
124 template<class Type>
125 void cmptMin(Field<typename Field<Type>::cmptType>& res, const UList<Type>& f);
126 
127 template<class Type>
128 tmp<Field<typename Field<Type>::cmptType>> cmptMin(const UList<Type>& f);
129 
130 template<class Type>
131 tmp<Field<typename Field<Type>::cmptType>>
132 cmptMin(const tmp<Field<Type>>& tf);
133 
134 
135 template<class Type>
136 void cmptAv(Field<typename Field<Type>::cmptType>& res, const UList<Type>& f);
137 
138 template<class Type>
139 tmp<Field<typename Field<Type>::cmptType>> cmptAv(const UList<Type>& f);
140 
141 template<class Type>
142 tmp<Field<typename Field<Type>::cmptType>> cmptAv(const tmp<Field<Type>>& tf);
143 
144 
145 template<class Type>
146 void cmptMag(Field<Type>& res, const UList<Type>& f);
147 
148 template<class Type>
149 tmp<Field<Type>> cmptMag(const UList<Type>& f);
150 
151 template<class Type>
152 tmp<Field<Type>> cmptMag(const tmp<Field<Type>>& tf);
153 
154 #define TMP_UNARY_FUNCTION(ReturnType, Func) \
155  \
156 template<class Type> \
157 ReturnType Func(const tmp<Field<Type>>& tf1);
158 
159 template<class Type>
160 Type max(const UList<Type>& f);
161 
162 TMP_UNARY_FUNCTION(Type, max)
163 
164 template<class Type>
165 Type min(const UList<Type>& f);
166 
167 TMP_UNARY_FUNCTION(Type, min)
168 
169 template<class Type>
170 Type sum(const UList<Type>& f);
171 
172 TMP_UNARY_FUNCTION(Type, sum)
173 
174 template<class Type>
175 Type maxMagSqr(const UList<Type>& f);
176 
177 TMP_UNARY_FUNCTION(Type, maxMagSqr)
178 
179 template<class Type>
180 Type minMagSqr(const UList<Type>& f);
181 
182 TMP_UNARY_FUNCTION(Type, minMagSqr)
183 
184 
185 template<class Type>
186 scalar sumProd(const UList<Type>& f1, const UList<Type>& f2);
187 
188 template<class Type>
189 Type sumCmptProd(const UList<Type>& f1, const UList<Type>& f2);
190 
191 template<class Type>
192 scalar sumSqr(const UList<Type>& f);
193 
194 TMP_UNARY_FUNCTION(scalar, sumSqr)
195 
196 template<class Type>
197 scalar sumMag(const UList<Type>& f);
198 
199 TMP_UNARY_FUNCTION(scalar, sumMag)
200 
201 template<class Type>
202 Type sumCmptMag(const UList<Type>& f);
203 
204 TMP_UNARY_FUNCTION(Type, sumCmptMag)
205 
206 template<class Type>
207 Type average(const UList<Type>& f);
208 
209 TMP_UNARY_FUNCTION(Type, average)
210 
211 
212 #define G_UNARY_FUNCTION(ReturnType, gFunc, Func, rFunc) \
213  \
214 template<class Type> \
215 ReturnType gFunc(const UList<Type>& f, const label comm = UPstream::worldComm);\
216 TMP_UNARY_FUNCTION(ReturnType, gFunc)
217 
218 G_UNARY_FUNCTION(Type, gMax, max, max)
219 G_UNARY_FUNCTION(Type, gMin, min, min)
220 G_UNARY_FUNCTION(Type, gSum, sum, sum)
221 G_UNARY_FUNCTION(Type, gMaxMagSqr, maxMagSqr, maxMagSqr)
222 G_UNARY_FUNCTION(Type, gMinMagSqr, minMagSqr, minMagSqr)
223 G_UNARY_FUNCTION(scalar, gSumSqr, sumSqr, sum)
224 G_UNARY_FUNCTION(scalar, gSumMag, sumMag, sum)
225 G_UNARY_FUNCTION(Type, gSumCmptMag, sumCmptMag, sum)
226 
227 #undef G_UNARY_FUNCTION
228 
229 template<class Type>
230 scalar gSumProd
231 (
232  const UList<Type>& f1,
233  const UList<Type>& f2,
234  const label comm = UPstream::worldComm
235 );
236 
237 template<class Type>
238 Type gSumCmptProd
239 (
240  const UList<Type>& f1,
241  const UList<Type>& f2,
242  const label comm = UPstream::worldComm
243 );
244 
245 template<class Type>
246 Type gAverage
247 (
248  const UList<Type>& f,
249  const label comm = UPstream::worldComm
250 );
251 
252 TMP_UNARY_FUNCTION(Type, gAverage)
253 
254 #undef TMP_UNARY_FUNCTION
255 
256 
257 BINARY_FUNCTION(Type, Type, Type, max)
258 BINARY_FUNCTION(Type, Type, Type, min)
259 BINARY_FUNCTION(Type, Type, Type, cmptMultiply)
260 BINARY_FUNCTION(Type, Type, Type, cmptDivide)
261 
262 BINARY_TYPE_FUNCTION(Type, Type, Type, max)
263 BINARY_TYPE_FUNCTION(Type, Type, Type, min)
264 BINARY_TYPE_FUNCTION(Type, Type, Type, cmptMultiply)
265 BINARY_TYPE_FUNCTION(Type, Type, Type, cmptDivide)
266 
267 
268 // * * * * * * * * * * * * * * * Global operators * * * * * * * * * * * * * //
269 
270 UNARY_OPERATOR(Type, Type, -, negate)
271 
272 BINARY_OPERATOR(Type, Type, scalar, *, multiply)
273 BINARY_OPERATOR(Type, scalar, Type, *, multiply)
274 BINARY_OPERATOR(Type, Type, scalar, /, divide)
275 
276 BINARY_TYPE_OPERATOR_SF(Type, scalar, Type, *, multiply)
277 BINARY_TYPE_OPERATOR_FS(Type, Type, scalar, *, multiply)
278 
279 BINARY_TYPE_OPERATOR_FS(Type, Type, scalar, /, divide)
280 
281 
282 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
283 
284 #define PRODUCT_OPERATOR(product, Op, OpFunc) \
285  \
286 template<class Type1, class Type2> \
287 void OpFunc \
288 ( \
289  Field<typename product<Type1, Type2>::type>& res, \
290  const UList<Type1>& f1, \
291  const UList<Type2>& f2 \
292 ); \
293  \
294 template<class Type1, class Type2> \
295 tmp<Field<typename product<Type1, Type2>::type>> \
296 operator Op(const UList<Type1>& f1, const UList<Type2>& f2); \
297  \
298 template<class Type1, class Type2> \
299 tmp<Field<typename product<Type1, Type2>::type>> \
300 operator Op(const UList<Type1>& f1, const tmp<Field<Type2>>& tf2); \
301  \
302 template<class Type1, class Type2> \
303 tmp<Field<typename product<Type1, Type2>::type>> \
304 operator Op(const tmp<Field<Type1>>& tf1, const UList<Type2>& f2); \
305  \
306 template<class Type1, class Type2> \
307 tmp<Field<typename product<Type1, Type2>::type>> \
308 operator Op(const tmp<Field<Type1>>& tf1, const tmp<Field<Type2>>& tf2); \
309  \
310 template<class Type, class Form, class Cmpt, direction nCmpt> \
311 void OpFunc \
312 ( \
313  Field<typename product<Type, Form>::type>& res, \
314  const UList<Type>& f1, \
315  const VectorSpace<Form,Cmpt,nCmpt>& vs \
316 ); \
317  \
318 template<class Type, class Form, class Cmpt, direction nCmpt> \
319 tmp<Field<typename product<Type, Form>::type>> \
320 operator Op(const UList<Type>& f1, const VectorSpace<Form,Cmpt,nCmpt>& vs); \
321  \
322 template<class Type, class Form, class Cmpt, direction nCmpt> \
323 tmp<Field<typename product<Type, Form>::type>> \
324 operator Op(const tmp<Field<Type>>&tf1,const VectorSpace<Form,Cmpt,nCmpt>&vs); \
325  \
326 template<class Form, class Cmpt, direction nCmpt, class Type> \
327 void OpFunc \
328 ( \
329  Field<typename product<Form, Type>::type>& res, \
330  const VectorSpace<Form,Cmpt,nCmpt>& vs, \
331  const UList<Type>& f1 \
332 ); \
333  \
334 template<class Form, class Cmpt, direction nCmpt, class Type> \
335 tmp<Field<typename product<Form, Type>::type>> \
336 operator Op(const VectorSpace<Form,Cmpt,nCmpt>& vs, const UList<Type>& f1); \
337  \
338 template<class Form, class Cmpt, direction nCmpt, class Type> \
339 tmp<Field<typename product<Form, Type>::type>> \
340 operator Op(const VectorSpace<Form,Cmpt,nCmpt>&vs,const tmp<Field<Type>>&tf1);
341 
342 PRODUCT_OPERATOR(typeOfSum, +, add)
343 PRODUCT_OPERATOR(typeOfSum, -, subtract)
344 
345 PRODUCT_OPERATOR(outerProduct, *, outer)
346 PRODUCT_OPERATOR(crossProduct, ^, cross)
347 PRODUCT_OPERATOR(innerProduct, &, dot)
348 PRODUCT_OPERATOR(scalarProduct, &&, dotdot)
349 
350 #undef PRODUCT_OPERATOR
351 
352 
353 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
354 
355 } // End namespace Foam
356 
357 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
358 
359 #include "undefFieldFunctionsM.H"
360 #include "scalarField.H"
361 
362 // ************************************************************************* //
BINARY_TYPE_FUNCTION
#define BINARY_TYPE_FUNCTION(ReturnType, Type1, Type2, Func)
Definition: DimensionedFieldFunctionsM.C:448
FieldFunctionsM.H
High performance macro functions for Field<Type> algebra. These expand using either array element acc...
G_UNARY_FUNCTION
#define G_UNARY_FUNCTION(ReturnType, gFunc, Func, rFunc)
Definition: FieldFunctions.H:212
PRODUCT_OPERATOR
#define PRODUCT_OPERATOR(product, Op, OpFunc)
Definition: FieldFunctions.H:284
TMP_UNARY_FUNCTION
#define TMP_UNARY_FUNCTION(ReturnType, Func)
Definition: FieldFunctions.H:154
BINARY_TYPE_OPERATOR_FS
#define BINARY_TYPE_OPERATOR_FS(TYPE, op, opFunc)
Definition: LagrangianPatchFieldFunctions.H:179
BINARY_FUNCTION
#define BINARY_FUNCTION(func)
Definition: LagrangianPatchFieldFunctions.H:108
BINARY_OPERATOR
#define BINARY_OPERATOR(Template, Type, Type1, Type2, op, opFunc)
Definition: LagrangianPatchFieldFunctions.H:149
UNARY_OPERATOR
#define UNARY_OPERATOR(op, opFunc)
Definition: LagrangianPatchFieldFunctions.H:138
BINARY_TYPE_OPERATOR_SF
#define BINARY_TYPE_OPERATOR_SF(TYPE, op, opFunc)
Definition: LagrangianPatchFieldFunctions.H:168
Foam::Field::cmptType
pTraits< Type >::cmptType cmptType
Component type.
Definition: Field.H:98
Foam::UPstream::worldComm
static label worldComm
Default communicator (all processors)
Definition: UPstream.H:278
Foam::outerProduct::type
typeOfRank< typename pTraits< arg1 >::cmptType, direction(pTraits< arg1 >::rank)+direction(pTraits< arg2 >::rank) >::type type
Definition: products.H:90
Foam::powProduct::type
symmTypeOfRank< typename pTraits< arg1 >::cmptType, arg2 *direction(pTraits< arg1 >::rank) >::type type
Definition: products.H:136
tf
const tensorField & tf
Definition: getPatchFieldTensor.H:36
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.H:214
Foam::subtract
void subtract(LagrangianPatchField< typename typeOfSum< Type1, Type2 >::type > &f, const LagrangianPatchField< Type1 > &f1, const LagrangianPatchField< Type2 > &f2)
Definition: LagrangianPatchFieldFunctions.H:228
Foam::dot
void dot(LagrangianPatchField< typename innerProduct< Type1, Type2 >::type > &f, const LagrangianPatchField< Type1 > &f1, const LagrangianPatchField< Type2 > &f2)
Definition: LagrangianPatchFieldFunctions.H:231
Foam::negate
void negate(LagrangianPatchField< Type > &f, const LagrangianPatchField< Type > &f1)
Definition: LagrangianPatchFieldFunctions.H:144
Foam::cmptMultiply
void cmptMultiply(LagrangianPatchField< Type > &f, const LagrangianPatchField< Type > &f1, const LagrangianPatchField< Type > &f2)
Definition: LagrangianPatchFieldFunctions.H:130
Foam::gSum
Type gSum(const FieldField< Field, Type > &f)
Definition: FieldFieldFunctions.C:559
Foam::outer
void outer(LagrangianPatchField< typename outerProduct< Type1, Type2 >::type > &f, const LagrangianPatchField< Type1 > &f1, const LagrangianPatchField< Type2 > &f2)
Definition: LagrangianPatchFieldFunctions.H:229
Foam::divide
void divide(LagrangianPatchField< Type > &f, const LagrangianPatchField< Type > &f1, const LagrangianPatchField< scalar > &f2)
Definition: LagrangianPatchFieldFunctions.H:163
Foam::dotdot
void dotdot(LagrangianPatchField< typename scalarProduct< Type1, Type2 >::type > &f, const LagrangianPatchField< Type1 > &f1, const LagrangianPatchField< Type2 > &f2)
Definition: LagrangianPatchFieldFunctions.H:232
Foam::label
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Foam::gSumMag
scalar gSumMag(const FieldField< Field, Type > &f)
Definition: FieldFieldFunctions.C:560
Foam::cmptDivide
void cmptDivide(LagrangianPatchField< Type > &f, const LagrangianPatchField< Type > &f1, const LagrangianPatchField< Type > &f2)
Definition: LagrangianPatchFieldFunctions.H:131
Foam::gSumSqr
scalar gSumSqr(const UList< Type > &f, const label comm)
Definition: FieldFunctions.C:546
Foam::gSumProd
scalar gSumProd(const UList< Type > &f1, const UList< Type > &f2, const label comm)
Definition: FieldFunctions.C:554
Foam::T
void T(LagrangianPatchField< Type > &f, const LagrangianPatchField< Type > &f1)
Definition: LagrangianPatchFieldFunctions.H:90
Foam::average
dimensioned< Type > average(const DimensionedField< Type, GeoMesh, PrimitiveField > &df)
Definition: DimensionedFieldFunctions.C:377
Foam::cmptMin
void cmptMin(FieldField< Field, typename FieldField< Field, Type >::cmptType > &cf, const FieldField< Field, Type > &f)
Definition: FieldFieldFunctions.C:269
Foam::sumMag
dimensioned< scalar > sumMag(const DimensionedField< Type, GeoMesh, PrimitiveField > &df)
Definition: DimensionedFieldFunctions.C:376
Foam::sumCmptProd
Type sumCmptProd(const UList< Type > &f1, const UList< Type > &f2)
Definition: FieldFunctions.C:432
Foam::maxMagSqr
Type maxMagSqr(const UList< Type > &f)
Definition: FieldFunctions.C:362
Foam::cross
void cross(LagrangianPatchField< typename crossProduct< Type1, Type2 >::type > &f, const LagrangianPatchField< Type1 > &f1, const LagrangianPatchField< Type2 > &f2)
Definition: LagrangianPatchFieldFunctions.H:230
Foam::mag
void mag(LagrangianPatchField< scalar > &f, const LagrangianPatchField< Type > &f1)
Definition: LagrangianPatchFieldFunctions.H:60
Foam::min
layerAndWeight min(const layerAndWeight &a, const layerAndWeight &b)
Definition: moving_fvMeshStitcher.C:110
Foam::gMaxMagSqr
Type gMaxMagSqr(const UList< Type > &f, const label comm)
Definition: FieldFunctions.C:544
Foam::component
void component(LagrangianPatchField< typename LagrangianPatchField< Type >::cmptType > &sf, const LagrangianPatchField< Type > &f, const direction d)
Definition: LagrangianPatchFieldFunctions.H:41
Foam::pow
void pow(LagrangianPatchField< typename powProduct< Type, r >::type > &f, const LagrangianPatchField< Type > &f1)
Definition: LagrangianPatchFieldFunctions.H:75
Foam::multiply
void multiply(LagrangianPatchField< Type > &f, const LagrangianPatchField< scalar > &f1, const LagrangianPatchField< Type > &f2)
Definition: LagrangianPatchFieldFunctions.H:160
Foam::sumProd
scalar sumProd(const UList< Type > &f1, const UList< Type > &f2)
Definition: FieldFunctions.C:416
Foam::cmptAv
void cmptAv(LagrangianPatchField< typename LagrangianPatchField< Type >::cmptType > &f, const LagrangianPatchField< Type > &f1)
Definition: LagrangianPatchFieldFunctions.H:67
Foam::sum
dimensioned< Type > sum(const DimensionedField< Type, GeoMesh, PrimitiveField > &df)
Definition: DimensionedFieldFunctions.C:375
Foam::max
layerAndWeight max(const layerAndWeight &a, const layerAndWeight &b)
Definition: moving_fvMeshStitcher.C:104
Foam::sqr
void sqr(LagrangianPatchField< typename outerProduct< Type, Type >::type > &f, const LagrangianPatchField< Type > &f1)
Definition: LagrangianPatchFieldFunctions.H:82
Foam::cmptMax
void cmptMax(FieldField< Field, typename FieldField< Field, Type >::cmptType > &cf, const FieldField< Field, Type > &f)
Definition: FieldFieldFunctions.C:224
Foam::gAverage
Type gAverage(const FieldField< Field, Type > &f)
Definition: FieldFieldFunctions.C:566
Foam::minMagSqr
Type minMagSqr(const UList< Type > &f)
Definition: FieldFunctions.C:389
Foam::magSqr
void magSqr(LagrangianPatchField< scalar > &f, const LagrangianPatchField< Type > &f1)
Definition: LagrangianPatchFieldFunctions.H:59
Foam::gMin
Type gMin(const FieldField< Field, Type > &f)
Definition: FieldFieldFunctions.C:558
Foam::sumSqr
scalar sumSqr(const UList< Type > &f)
Definition: FieldFunctions.C:458
Foam::add
void add(LagrangianPatchField< typename typeOfSum< Type1, Type2 >::type > &f, const LagrangianPatchField< Type1 > &f1, const LagrangianPatchField< Type2 > &f2)
Definition: LagrangianPatchFieldFunctions.H:227
Foam::gMinMagSqr
Type gMinMagSqr(const UList< Type > &f, const label comm)
Definition: FieldFunctions.C:545
Foam::gSumCmptMag
Type gSumCmptMag(const UList< Type > &f, const label comm)
Definition: FieldFunctions.C:548
Foam::gMax
Type gMax(const FieldField< Field, Type > &f)
Definition: FieldFieldFunctions.C:557
Foam::cmptMag
void cmptMag(LagrangianPatchField< Type > &f, const LagrangianPatchField< Type > &f1)
Definition: LagrangianPatchFieldFunctions.H:68
Foam::sumCmptMag
Type sumCmptMag(const UList< Type > &f)
Definition: FieldFunctions.C:493
Foam::direction
uint8_t direction
Definition: direction.H:45
Foam::gSumCmptProd
Type gSumCmptProd(const UList< Type > &f1, const UList< Type > &f2, const label comm)
Definition: FieldFunctions.C:567
f
labelList f(nPoints)