ENH: add cmptMagSqr for scalars, VectorSpace, Fields (#1449)

applications/test/vector/Test-vector.C

@@ -45,6 +45,7 @@ void printInfo(const vector& vec)
         << " sum:" << cmptSum(vec)
         << " prod:" << cmptProduct(vec)
         << " mag:" << cmptMag(vec)
+        << " magSqr:" << cmptMagSqr(vec)
         << nl << nl;
 }
 

src/OpenFOAM/fields/Fields/Field/FieldFunctions.C

@@ -322,6 +322,30 @@ tmp<Field<Type>> cmptMag(const tmp<Field<Type>>& tf)
 }
 
 
+template<class Type>
+void cmptMagSqr(Field<Type>& res, const UList<Type>& f)
+{
+    TFOR_ALL_F_OP_FUNC_F(Type, res, =, cmptMagSqr, Type, f)
+}
+
+template<class Type>
+tmp<Field<Type>> cmptMagSqr(const UList<Type>& f)
+{
+    auto tres = tmp<Field<Type>>::New(f.size());
+    cmptMagSqr(tres.ref(), f);
+    return tres;
+}
+
+template<class Type>
+tmp<Field<Type>> cmptMagSqr(const tmp<Field<Type>>& tf)
+{
+    auto tres = New(tf);
+    cmptMagSqr(tres.ref(), tf());
+    tf.clear();
+    return tres;
+}
+
+
 #define TMP_UNARY_FUNCTION(ReturnType, Func)                                   \
                                                                                \
 template<class Type>                                                           \

src/OpenFOAM/fields/Fields/Field/FieldFunctions.H

@@ -167,6 +167,16 @@ template<class Type>
 tmp<Field<Type>> cmptMag(const tmp<Field<Type>>& tf);
 
 
+template<class Type>
+void cmptMagSqr(Field<Type>& res, const UList<Type>& f);
+
+template<class Type>
+tmp<Field<Type>> cmptMagSqr(const UList<Type>& f);
+
+template<class Type>
+tmp<Field<Type>> cmptMagSqr(const tmp<Field<Type>>& tf);
+
+
 #define TMP_UNARY_FUNCTION(ReturnType, Func)                                   \
                                                                                \
 /** \brief  Apply the \c Func() function on the tmp field */                   \

src/OpenFOAM/primitives/Scalar/Scalar.H

@@ -382,6 +382,12 @@ inline Scalar cmptMag(const Scalar s)
 }
 
 
+inline Scalar cmptMagSqr(const Scalar s)
+{
+    return magSqr(s);
+}
+
+
 inline Scalar sqrtSumSqr(const Scalar a, const Scalar b)
 {
     const Scalar maga = mag(a);

src/OpenFOAM/primitives/VectorSpace/VectorSpaceI.H

@@ -635,6 +635,18 @@ inline Form cmptMag
 }
 
 
+template<class Form, class Cmpt, direction Ncmpts>
+inline Form cmptMagSqr
+(
+    const VectorSpace<Form, Cmpt, Ncmpts>& vs
+)
+{
+    Form v;
+    VectorSpaceOps<Ncmpts,0>::eqOp(v, vs, eqMagSqrOp<Cmpt>());
+    return v;
+}
+
+
 template<class Form, class Cmpt, direction Ncmpts>
 inline Form max
 (

src/OpenFOAM/primitives/ops/ops.H

@@ -74,6 +74,7 @@ EqOp(multiplyEq, x *= y)
 EqOp(divideEq, x /= y)
 EqOp(eqSqr, x = sqr(y))
 EqOp(eqMag, x = mag(y))
+EqOp(eqMagSqr, x = magSqr(y))
 EqOp(plusEqMagSqr, x += magSqr(y))
 EqOp(maxEq, x = max(x, y))
 EqOp(minEq, x = min(x, y))