From 567fced30b157f8470fe227398654a4d248e4c26 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Thu, 4 Apr 2019 19:00:29 +0200
Subject: [PATCH] ENH: add pTraits<complex> (#1247)
---
applications/test/complex/Test-complex.C | 35 +++++++++++-
applications/test/minMax1/Test-minMax1.C | 23 ++++++++
src/OpenFOAM/primitives/complex/complex.C | 35 ++++++++++++
src/OpenFOAM/primitives/complex/complex.H | 64 ++++++++++++++++++++++
src/OpenFOAM/primitives/complex/complexI.H | 1 +
5 files changed, 155 insertions(+), 3 deletions(-)
diff --git a/applications/test/complex/Test-complex.C b/applications/test/complex/Test-complex.C
index bc4d3d05dc7..938f63fb8eb 100644
--- a/applications/test/complex/Test-complex.C
+++ b/applications/test/complex/Test-complex.C
@@ -30,6 +30,8 @@ Description
#include "argList.H"
#include "complexFields.H"
+#include "ops.H"
+#include "ListOps.H"
using namespace Foam;
@@ -97,9 +99,6 @@ int main(int argc, char *argv[])
}
- Info<< "sum = " << sum(fld1) << nl;
- // Not yet Info<< "min = " << min(fld1) << nl;
-
fld1 *= 10;
Info<< "scalar multiply: " << flatOutput(fld1) << nl;
@@ -120,6 +119,36 @@ int main(int argc, char *argv[])
// Info<< "pow(2) : " << pow(fld1, 2) << nl;
+ // Make some changes
+ {
+ label i = 1;
+ for (complex& c : fld1)
+ {
+ c.Re() += i;
+ c.Im() -= 10 - i;
+ ++i;
+ }
+ }
+
+ Info<< nl
+ << "field = " << fld1 << nl;
+
+ Info<< "magSqr = "
+ << ListOps::create<scalar>
+ (
+ fld1,
+ [](const complex& c) { return magSqr(c); }
+ )
+ << nl;
+
+ Info
+ << "sum = " << sum(fld1) << nl
+ << "min = " << min(fld1) << nl
+ << "max = " << max(fld1) << nl;
+
+ // MinMax fails since there is no less comparison operator
+ // Info<< "min/max = " << MinMax<complex>(fld1) << nl;
+
Info<< "\nEnd\n" << endl;
return 0;
}
diff --git a/applications/test/minMax1/Test-minMax1.C b/applications/test/minMax1/Test-minMax1.C
index 26d242a8041..a33b3a31342 100644
--- a/applications/test/minMax1/Test-minMax1.C
+++ b/applications/test/minMax1/Test-minMax1.C
@@ -32,6 +32,7 @@ Description
#include "HashOps.H"
#include "ListOps.H"
#include "scalarField.H"
+#include "complexField.H"
#include "MinMax.H"
#include "dimensionedScalar.H"
@@ -47,6 +48,19 @@ Ostream& printInfo(const MinMax<T>& range)
}
+template<class T>
+void testUniformField(const T& val)
+{
+ constexpr label N = 10;
+
+ // Field<T> fld(N, val);
+ List<T> fld(N, val);
+
+ Info<< "field: " << fld << nl
+ << "min/max: " << minMaxMag(fld) << nl;
+}
+
+
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Main program:
@@ -225,6 +239,15 @@ int main(int argc, char *argv[])
Info<< "filtered: " << hashed << nl;
}
+
+ // Min/max of uniform fields
+ {
+ testUniformField<scalar>(100);
+ // testUniformField<complex>(complex(100, 0));
+ }
+
+ Info<< "\nEnd\n" << nl;
+
return 0;
}
diff --git a/src/OpenFOAM/primitives/complex/complex.C b/src/OpenFOAM/primitives/complex/complex.C
index 1368df2ae44..277864c487b 100644
--- a/src/OpenFOAM/primitives/complex/complex.C
+++ b/src/OpenFOAM/primitives/complex/complex.C
@@ -35,6 +35,41 @@ const Foam::complex Foam::complex::zero(0, 0);
const Foam::complex Foam::complex::one(1, 0);
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+const char* const Foam::pTraits<Foam::complex>::typeName = "complex";
+const char* const Foam::pTraits<Foam::complex>::componentNames[] = {"re", "im"};
+
+const Foam::complex Foam::pTraits<Foam::complex>::zero(0, 0);
+const Foam::complex Foam::pTraits<Foam::complex>::one(1, 0);
+
+const Foam::complex Foam::pTraits<Foam::complex>::min(-VGREAT, -VGREAT);
+const Foam::complex Foam::pTraits<Foam::complex>::max(VGREAT, VGREAT);
+
+const Foam::complex Foam::pTraits<Foam::complex>::rootMin
+(
+ -ROOTVGREAT, -ROOTVGREAT
+);
+
+const Foam::complex Foam::pTraits<Foam::complex>::rootMax
+(
+ ROOTVGREAT, ROOTVGREAT
+);
+
+
+Foam::pTraits<Foam::complex>::pTraits(const complex& val)
+:
+ p_(val)
+{}
+
+
+Foam::pTraits<Foam::complex>::pTraits(Istream& is)
+{
+ is >> p_;
+}
+
+
+
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::complex::complex(Istream& is)
diff --git a/src/OpenFOAM/primitives/complex/complex.H b/src/OpenFOAM/primitives/complex/complex.H
index 48e3505d193..06f4eded4e1 100644
--- a/src/OpenFOAM/primitives/complex/complex.H
+++ b/src/OpenFOAM/primitives/complex/complex.H
@@ -232,6 +232,70 @@ public:
};
+// Template specialisation for pTraits<complex>
+template<>
+class pTraits<complex>
+{
+ complex p_;
+
+public:
+
+ //- Component type
+ typedef complex cmptType;
+
+ //- Equivalent type of labels used for valid component indexing
+ typedef label labelType;
+
+
+ // Member constants
+
+ //- Dimensionality of space
+ static constexpr direction dim = 3;
+
+ //- Rank of complex is 0
+ static constexpr direction rank = 0;
+
+ //- Number of components in complex is 2
+ static constexpr direction nComponents = 2;
+
+
+ // Static Data Members
+
+ static const char* const typeName;
+ static const char* const componentNames[];
+ static const complex zero;
+ static const complex one;
+ static const complex max;
+ static const complex min;
+ static const complex rootMax;
+ static const complex rootMin;
+
+
+ // Constructors
+
+ //- Construct from primitive
+ explicit pTraits(const complex& val);
+
+ //- Construct from Istream
+ pTraits(Istream& is);
+
+
+ // Member Functions
+
+ //- Access to the value
+ operator complex() const
+ {
+ return p_;
+ }
+
+ //- Access to the value
+ operator complex&()
+ {
+ return p_;
+ }
+};
+
+
// * * * * * * * * * * * * * * * Global Operators * * * * * * * * * * * * * //
Istream& operator>>(Istream& is, complex& c);
diff --git a/src/OpenFOAM/primitives/complex/complexI.H b/src/OpenFOAM/primitives/complex/complexI.H
index 25b6cc5a492..16e8594fb43 100644
--- a/src/OpenFOAM/primitives/complex/complexI.H
+++ b/src/OpenFOAM/primitives/complex/complexI.H
@@ -350,6 +350,7 @@ inline complex operator/(const scalar s, const complex& c)
return complex(s/c.re, s/c.im);
}
+
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
--
GitLab