OpenFOAM-5.x/src/OpenFOAM/fields/FieldFields/FieldField/FieldFieldFunctions.C
Henry Weller f2b111e203 src/OpenFOAM: changed template rank type from int to Foam::direction
Foam::direction is an unsigned type which makes it easier for the
compiler to pickup and report errors in the instantiation of
VectorSpaces and associated types.
2016-03-09 10:10:28 +00:00

922 lines
37 KiB
C

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 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 "PstreamReduceOps.H"
#include "FieldFieldReuseFunctions.H"
#define TEMPLATE template<template<class> class Field, class Type>
#include "FieldFieldFunctionsM.C"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/* * * * * * * * * * * * * * * * Global functions * * * * * * * * * * * * * */
template<template<class> class Field, class Type>
void component
(
FieldField<Field, typename FieldField<Field, Type>::cmptType>& sf,
const FieldField<Field, Type>& f,
const direction d
)
{
forAll(sf, i)
{
component(sf[i], f[i], d);
}
}
template<template<class> class Field, class Type>
void T(FieldField<Field, Type>& f1, const FieldField<Field, Type>& f2)
{
forAll(f1, i)
{
T(f1[i], f2[i]);
}
}
template<template<class> class Field, class Type, direction r>
void pow
(
FieldField<Field, typename powProduct<Type, r>::type>& f,
const FieldField<Field, Type>& vf
)
{
forAll(f, i)
{
pow(f[i], vf[i]);
}
}
template<template<class> class Field, class Type, direction r>
tmp<FieldField<Field, typename powProduct<Type, r>::type>>
pow
(
const FieldField<Field, Type>& f, typename powProduct<Type, r>::type
)
{
typedef typename powProduct<Type, r>::type powProductType;
tmp<FieldField<Field, powProductType>> tRes
(
FieldField<Field, powProductType>::NewCalculatedType(f)
);
pow<Type, r>(tRes.ref(), f);
return tRes;
}
template<template<class> class Field, class Type, direction r>
tmp<FieldField<Field, typename powProduct<Type, r>::type>>
pow
(
const tmp<FieldField<Field, Type>>& tf, typename powProduct<Type, r>::type
)
{
typedef typename powProduct<Type, r>::type powProductType;
tmp<FieldField<Field, powProductType>> tRes
(
reuseTmpFieldField<Field, powProductType, Type>::New(tf)
);
pow<Type, r>(tRes.ref(), tf());
tf.clear();
return tRes;
}
template<template<class> class Field, class Type>
void sqr
(
FieldField<Field, typename outerProduct<Type, Type>::type>& f,
const FieldField<Field, Type>& vf
)
{
forAll(f, i)
{
sqr(f[i], vf[i]);
}
}
template<template<class> class Field, class Type>
tmp<FieldField<Field, typename outerProduct<Type, Type>::type>>
sqr(const FieldField<Field, Type>& f)
{
typedef typename outerProduct<Type, Type>::type outerProductType;
tmp<FieldField<Field, outerProductType>> tRes
(
FieldField<Field, outerProductType>::NewCalculatedType(f)
);
sqr(tRes.ref(), f);
return tRes;
}
template<template<class> class Field, class Type>
tmp<FieldField<Field, typename outerProduct<Type, Type>::type>>
sqr(const tmp<FieldField<Field, Type>>& tf)
{
typedef typename outerProduct<Type, Type>::type outerProductType;
tmp<FieldField<Field, outerProductType>> tRes
(
reuseTmpFieldField<Field, outerProductType, Type>::New(tf)
);
sqr(tRes.ref(), tf());
tf.clear();
return tRes;
}
template<template<class> class Field, class Type>
void magSqr(FieldField<Field, scalar>& sf, const FieldField<Field, Type>& f)
{
forAll(sf, i)
{
magSqr(sf[i], f[i]);
}
}
template<template<class> class Field, class Type>
tmp<FieldField<Field, scalar>> magSqr(const FieldField<Field, Type>& f)
{
tmp<FieldField<Field, scalar>> tRes
(
FieldField<Field, scalar>::NewCalculatedType(f)
);
magSqr(tRes.ref(), f);
return tRes;
}
template<template<class> class Field, class Type>
tmp<FieldField<Field, scalar>> magSqr(const tmp<FieldField<Field, Type>>& tf)
{
tmp<FieldField<Field, scalar>> tRes
(
reuseTmpFieldField<Field, scalar, Type>::New(tf)
);
magSqr(tRes.ref(), tf());
tf.clear();
return tRes;
}
template<template<class> class Field, class Type>
void mag(FieldField<Field, scalar>& sf, const FieldField<Field, Type>& f)
{
forAll(sf, i)
{
mag(sf[i], f[i]);
}
}
template<template<class> class Field, class Type>
tmp<FieldField<Field, scalar>> mag(const FieldField<Field, Type>& f)
{
tmp<FieldField<Field, scalar>> tRes
(
FieldField<Field, scalar>::NewCalculatedType(f)
);
mag(tRes.ref(), f);
return tRes;
}
template<template<class> class Field, class Type>
tmp<FieldField<Field, scalar>> mag(const tmp<FieldField<Field, Type>>& tf)
{
tmp<FieldField<Field, scalar>> tRes
(
reuseTmpFieldField<Field, scalar, Type>::New(tf)
);
mag(tRes.ref(), tf());
tf.clear();
return tRes;
}
template<template<class> class Field, class Type>
void cmptMax
(
FieldField<Field, typename FieldField<Field, Type>::cmptType>& cf,
const FieldField<Field, Type>& f
)
{
forAll(cf, i)
{
cmptMax(cf[i], f[i]);
}
}
template<template<class> class Field, class Type>
tmp<FieldField<Field, typename FieldField<Field, Type>::cmptType>> cmptMax
(
const FieldField<Field, Type>& f
)
{
typedef typename FieldField<Field, Type>::cmptType cmptType;
tmp<FieldField<Field, cmptType>> tRes
(
FieldField<Field, cmptType>::NewCalculatedType(f)
);
cmptMax(tRes.ref(), f);
return tRes;
}
template<template<class> class Field, class Type>
tmp<FieldField<Field, typename FieldField<Field, Type>::cmptType>> cmptMax
(
const tmp<FieldField<Field, Type>>& tf
)
{
typedef typename FieldField<Field, Type>::cmptType cmptType;
tmp<FieldField<Field, cmptType>> tRes
(
reuseTmpFieldField<Field, cmptType, Type>::New(tf)
);
cmptMax(tRes.ref(), tf());
tf.clear();
return tRes;
}
template<template<class> class Field, class Type>
void cmptMin
(
FieldField<Field, typename FieldField<Field, Type>::cmptType>& cf,
const FieldField<Field, Type>& f
)
{
forAll(cf, i)
{
cmptMin(cf[i], f[i]);
}
}
template<template<class> class Field, class Type>
tmp<FieldField<Field, typename FieldField<Field, Type>::cmptType>> cmptMin
(
const FieldField<Field, Type>& f
)
{
typedef typename FieldField<Field, Type>::cmptType cmptType;
tmp<FieldField<Field, cmptType>> tRes
(
FieldField<Field, cmptType>::NewCalculatedType(f)
);
cmptMin(tRes.ref(), f);
return tRes;
}
template<template<class> class Field, class Type>
tmp<FieldField<Field, typename FieldField<Field, Type>::cmptType>> cmptMin
(
const tmp<FieldField<Field, Type>>& tf
)
{
typedef typename FieldField<Field, Type>::cmptType cmptType;
tmp<FieldField<Field, cmptType>> tRes
(
reuseTmpFieldField<Field, cmptType, Type>::New(tf)
);
cmptMin(tRes.ref(), tf());
tf.clear();
return tRes;
}
template<template<class> class Field, class Type>
void cmptAv
(
FieldField<Field, typename FieldField<Field, Type>::cmptType>& cf,
const FieldField<Field, Type>& f
)
{
forAll(cf, i)
{
cmptAv(cf[i], f[i]);
}
}
template<template<class> class Field, class Type>
tmp<FieldField<Field, typename FieldField<Field, Type>::cmptType>> cmptAv
(
const FieldField<Field, Type>& f
)
{
typedef typename FieldField<Field, Type>::cmptType cmptType;
tmp<FieldField<Field, cmptType>> tRes
(
FieldField<Field, cmptType>::NewCalculatedType(f)
);
cmptAv(tRes.ref(), f);
return tRes;
}
template<template<class> class Field, class Type>
tmp<FieldField<Field, typename FieldField<Field, Type>::cmptType>> cmptAv
(
const tmp<FieldField<Field, Type>>& tf
)
{
typedef typename FieldField<Field, Type>::cmptType cmptType;
tmp<FieldField<Field, cmptType>> tRes
(
reuseTmpFieldField<Field, cmptType, Type>::New(tf)
);
cmptAv(tRes.ref(), tf());
tf.clear();
return tRes;
}
template<template<class> class Field, class Type>
void cmptMag
(
FieldField<Field, Type>& cf,
const FieldField<Field, Type>& f
)
{
forAll(cf, i)
{
cmptMag(cf[i], f[i]);
}
}
template<template<class> class Field, class Type>
tmp<FieldField<Field, Type>> cmptMag
(
const FieldField<Field, Type>& f
)
{
tmp<FieldField<Field, Type>> tRes
(
FieldField<Field, Type>::NewCalculatedType(f)
);
cmptMag(tRes.ref(), f);
return tRes;
}
template<template<class> class Field, class Type>
tmp<FieldField<Field, Type>> cmptMag
(
const tmp<FieldField<Field, Type>>& tf
)
{
tmp<FieldField<Field, Type>> tRes(New(tf));
cmptMag(tRes.ref(), tf());
tf.clear();
return tRes;
}
#define TMP_UNARY_FUNCTION(returnType, func) \
\
template<template<class> class Field, class Type> \
returnType func(const tmp<FieldField<Field, Type>>& tf1) \
{ \
returnType res = func(tf1()); \
tf1.clear(); \
return res; \
}
template<template<class> class Field, class Type>
Type max(const FieldField<Field, Type>& f)
{
label i = 0;
while (i < f.size() && !f[i].size()) i++;
if (i < f.size())
{
Type Max(max(f[i]));
for (label j=i+1; j<f.size(); j++)
{
if (f[j].size())
{
Max = max(max(f[j]), Max);
}
}
return Max;
}
else
{
return pTraits<Type>::min;
}
}
TMP_UNARY_FUNCTION(Type, max)
template<template<class> class Field, class Type>
Type min(const FieldField<Field, Type>& f)
{
label i = 0;
while (i < f.size() && !f[i].size()) i++;
if (i < f.size())
{
label i = 0;
while (!f[i].size()) i++;
Type Min(min(f[i]));
for (label j=i+1; j<f.size(); j++)
{
if (f[j].size())
{
Min = min(min(f[j]), Min);
}
}
return Min;
}
else
{
return pTraits<Type>::max;
}
}
TMP_UNARY_FUNCTION(Type, min)
template<template<class> class Field, class Type>
Type sum(const FieldField<Field, Type>& f)
{
if (f.size())
{
Type Sum = pTraits<Type>::zero;
forAll(f, i)
{
Sum += sum(f[i]);
}
return Sum;
}
else
{
return pTraits<Type>::zero;
}
}
TMP_UNARY_FUNCTION(Type, sum)
template<template<class> class Field, class Type>
scalar sumMag(const FieldField<Field, Type>& f)
{
if (f.size())
{
scalar SumMag = 0.0;
forAll(f, i)
{
SumMag += sumMag(f[i]);
}
return SumMag;
}
else
{
return 0.0;
}
}
TMP_UNARY_FUNCTION(scalar, sumMag)
template<template<class> class Field, class Type>
Type average(const FieldField<Field, Type>& f)
{
if (f.size())
{
label n = 0;
forAll(f, i)
{
n += f[i].size();
}
if (n == 0)
{
WarningInFunction
<< "empty fieldField, returning zero" << endl;
return pTraits<Type>::zero;
}
Type avrg = sum(f)/n;
return avrg;
}
else
{
WarningInFunction
<< "empty fieldField, returning zero" << endl;
return pTraits<Type>::zero;
}
}
TMP_UNARY_FUNCTION(Type, average)
#include "PstreamReduceOps.H"
#define G_UNARY_FUNCTION(returnType, gFunc, func, rFunc) \
\
template<template<class> class Field, class Type> \
returnType gFunc(const FieldField<Field, Type>& f) \
{ \
returnType res = func(f); \
reduce(res, rFunc##Op<Type>()); \
return res; \
} \
TMP_UNARY_FUNCTION(returnType, gFunc)
G_UNARY_FUNCTION(Type, gMax, max, max)
G_UNARY_FUNCTION(Type, gMin, min, min)
G_UNARY_FUNCTION(Type, gSum, sum, sum)
G_UNARY_FUNCTION(scalar, gSumMag, sumMag, sum)
#undef G_UNARY_FUNCTION
template<template<class> class Field, class Type>
Type gAverage(const FieldField<Field, Type>& f)
{
label n = 0;
forAll(f, i)
{
n += f[i].size();
}
reduce(n, sumOp<label>());
if (n > 0)
{
Type avrg = gSum(f)/n;
return avrg;
}
else
{
WarningInFunction
<< "empty fieldField, returning zero" << endl;
return pTraits<Type>::zero;
}
}
TMP_UNARY_FUNCTION(Type, gAverage)
#undef TMP_UNARY_FUNCTION
BINARY_FUNCTION(Type, Type, Type, max)
BINARY_FUNCTION(Type, Type, Type, min)
BINARY_FUNCTION(Type, Type, Type, cmptMultiply)
BINARY_FUNCTION(Type, Type, Type, cmptDivide)
BINARY_TYPE_FUNCTION(Type, Type, Type, max)
BINARY_TYPE_FUNCTION(Type, Type, Type, min)
BINARY_TYPE_FUNCTION(Type, Type, Type, cmptMultiply)
BINARY_TYPE_FUNCTION(Type, Type, Type, cmptDivide)
/* * * * * * * * * * * * * * * * Global operators * * * * * * * * * * * * * */
UNARY_OPERATOR(Type, Type, -, negate)
BINARY_OPERATOR(Type, Type, scalar, *, multiply)
BINARY_OPERATOR(Type, scalar, Type, *, multiply)
BINARY_OPERATOR(Type, Type, scalar, /, divide)
BINARY_TYPE_OPERATOR_SF(Type, scalar, Type, *, multiply)
BINARY_TYPE_OPERATOR_FS(Type, Type, scalar, *, multiply)
BINARY_TYPE_OPERATOR_FS(Type, Type, scalar, /, divide)
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#define PRODUCT_OPERATOR(product, op, opFunc) \
\
template \
< \
template<class> class Field1, \
template<class> class Field2, \
class Type1, \
class Type2 \
> \
void opFunc \
( \
FieldField<Field1, typename product<Type1, Type2>::type>& f, \
const FieldField<Field1, Type1>& f1, \
const FieldField<Field2, Type2>& f2 \
) \
{ \
forAll(f, i) \
{ \
opFunc(f[i], f1[i], f2[i]); \
} \
} \
\
template \
< \
template<class> class Field1, \
template<class> class Field2, \
class Type1, \
class Type2 \
> \
tmp<FieldField<Field1, typename product<Type1, Type2>::type>> \
operator op \
( \
const FieldField<Field1, Type1>& f1, \
const FieldField<Field2, Type2>& f2 \
) \
{ \
typedef typename product<Type1, Type2>::type productType; \
tmp<FieldField<Field1, productType>> tRes \
( \
FieldField<Field1, productType>::NewCalculatedType(f1) \
); \
opFunc(tRes.ref(), f1, f2); \
return tRes; \
} \
\
template<template<class> class Field, class Type1, class Type2> \
tmp<FieldField<Field, typename product<Type1, Type2>::type>> \
operator op \
( \
const FieldField<Field, Type1>& f1, \
const tmp<FieldField<Field, Type2>>& tf2 \
) \
{ \
typedef typename product<Type1, Type2>::type productType; \
tmp<FieldField<Field, productType>> tRes \
( \
reuseTmpFieldField<Field, productType, Type2>::New(tf2) \
); \
opFunc(tRes.ref(), f1, tf2()); \
tf2.clear(); \
return tRes; \
} \
\
template \
< \
template<class> class Field1, \
template<class> class Field2, \
class Type1, \
class Type2 \
> \
tmp<FieldField<Field, typename product<Type1, Type2>::type>> \
operator op \
( \
const FieldField<Field1, Type1>& f1, \
const tmp<FieldField<Field2, Type2>>& tf2 \
) \
{ \
typedef typename product<Type1, Type2>::type productType; \
tmp<FieldField<Field1, productType>> tRes \
( \
FieldField<Field1, productType>::NewCalculatedType(f1) \
); \
opFunc(tRes.ref(), f1, tf2()); \
tf2.clear(); \
return tRes; \
} \
\
template \
< \
template<class> class Field1, \
template<class> class Field2, \
class Type1, \
class Type2 \
> \
tmp<FieldField<Field1, typename product<Type1, Type2>::type>> \
operator op \
( \
const tmp<FieldField<Field1, Type1>>& tf1, \
const FieldField<Field2, Type2>& f2 \
) \
{ \
typedef typename product<Type1, Type2>::type productType; \
tmp<FieldField<Field1, productType>> tRes \
( \
reuseTmpFieldField<Field1, productType, Type1>::New(tf1) \
); \
opFunc(tRes.ref(), tf1(), f2); \
tf1.clear(); \
return tRes; \
} \
\
template \
< \
template<class> class Field1, \
template<class> class Field2, \
class Type1, \
class Type2 \
> \
tmp<FieldField<Field1, typename product<Type1, Type2>::type>> \
operator op \
( \
const tmp<FieldField<Field1, Type1>>& tf1, \
const tmp<FieldField<Field2, Type2>>& tf2 \
) \
{ \
typedef typename product<Type1, Type2>::type productType; \
tmp<FieldField<Field1, productType>> tRes \
( \
reuseTmpTmpFieldField<Field1, productType, Type1, Type1, Type2>::New \
(tf1, tf2) \
); \
opFunc(tRes.ref(), tf1(), tf2()); \
tf1.clear(); \
tf2.clear(); \
return tRes; \
} \
\
template \
< \
template<class> class Field, \
class Type, \
class Form, \
class Cmpt, \
direction nCmpt \
> \
void opFunc \
( \
FieldField<Field, typename product<Type, Form>::type>& f, \
const FieldField<Field, Type>& f1, \
const VectorSpace<Form,Cmpt,nCmpt>& vs \
) \
{ \
forAll(f, i) \
{ \
opFunc(f[i], f1[i], vs); \
} \
} \
\
template \
< \
template<class> class Field, \
class Type, \
class Form, \
class Cmpt, \
direction nCmpt \
> \
tmp<FieldField<Field, typename product<Type, Form>::type>> \
operator op \
( \
const FieldField<Field, Type>& f1, \
const VectorSpace<Form,Cmpt,nCmpt>& vs \
) \
{ \
typedef typename product<Type, Form>::type productType; \
tmp<FieldField<Field, productType>> tRes \
( \
FieldField<Field, productType>::NewCalculatedType(f1) \
); \
opFunc(tRes.ref(), f1, static_cast<const Form&>(vs)); \
return tRes; \
} \
\
template \
< \
template<class> class Field, \
class Type, \
class Form, \
class Cmpt, \
direction nCmpt \
> \
tmp<FieldField<Field, typename product<Type, Form>::type>> \
operator op \
( \
const tmp<FieldField<Field, Type>>& tf1, \
const VectorSpace<Form,Cmpt,nCmpt>& vs \
) \
{ \
typedef typename product<Type, Form>::type productType; \
tmp<FieldField<Field, productType>> tRes \
( \
reuseTmpFieldField<Field, productType, Type>::New(tf1) \
); \
opFunc(tRes.ref(), tf1(), static_cast<const Form&>(vs)); \
tf1.clear(); \
return tRes; \
} \
\
template \
< \
template<class> class Field, \
class Type, \
class Form, \
class Cmpt, \
direction nCmpt \
> \
void opFunc \
( \
FieldField<Field, typename product<Form, Type>::type>& f, \
const VectorSpace<Form,Cmpt,nCmpt>& vs, \
const FieldField<Field, Type>& f1 \
) \
{ \
forAll(f, i) \
{ \
opFunc(f[i], vs, f1[i]); \
} \
} \
\
template \
< \
template<class> class Field, \
class Type, \
class Form, \
class Cmpt, \
direction nCmpt \
> \
tmp<FieldField<Field, typename product<Form, Type>::type>> \
operator op \
( \
const VectorSpace<Form,Cmpt,nCmpt>& vs, \
const FieldField<Field, Type>& f1 \
) \
{ \
typedef typename product<Form, Type>::type productType; \
tmp<FieldField<Field, productType>> tRes \
( \
FieldField<Field, productType>::NewCalculatedType(f1) \
); \
opFunc(tRes.ref(), static_cast<const Form&>(vs), f1); \
return tRes; \
} \
\
template \
< \
template<class> class Field, \
class Type, \
class Form, \
class Cmpt, \
direction nCmpt \
> \
tmp<FieldField<Field, typename product<Form, Type>::type>> \
operator op \
( \
const VectorSpace<Form,Cmpt,nCmpt>& vs, \
const tmp<FieldField<Field, Type>>& tf1 \
) \
{ \
typedef typename product<Form, Type>::type productType; \
tmp<FieldField<Field, productType>> tRes \
( \
reuseTmpFieldField<Field, productType, Type>::New(tf1) \
); \
opFunc(tRes.ref(), static_cast<const Form&>(vs), tf1()); \
tf1.clear(); \
return tRes; \
}
PRODUCT_OPERATOR(typeOfSum, +, add)
PRODUCT_OPERATOR(typeOfSum, -, subtract)
PRODUCT_OPERATOR(outerProduct, *, outer)
PRODUCT_OPERATOR(crossProduct, ^, cross)
PRODUCT_OPERATOR(innerProduct, &, dot)
PRODUCT_OPERATOR(scalarProduct, &&, dotdot)
#undef PRODUCT_OPERATOR
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "undefFieldFunctionsM.H"
// ************************************************************************* //