ENH: changed definition of complex::one (#1247)

- was historically defined as (1 1), but it is more consistent with
  the concept of one to have a real component only.

  Now defined as (1 0):  1+0i

STYLE: remove obscure '!' operator for complex conjugate

- either use the member function or the '~' operator

applications/test/complex/Test-complex.C

@@ -56,11 +56,10 @@ int main(int argc, char *argv[])
         << "complexVector::one  : " << complexVector::one << nl
         << nl;
 
-    // Comparison
-
     for (complex c : { complex{1, 0}, complex{1, 2}} )
     {
         print1(c);
+
         // TDB: allow implicit construct from scalar?
         //
         // if (c == 1.0)

src/OpenFOAM/primitives/Vector/complexVector/complexVector.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           |
+    \\  /    A nd           | Copyright (C) 2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
                             | Copyright (C) 2011 OpenFOAM Foundation
@@ -27,7 +27,7 @@ Typedef
     Foam::complexVector
 
 Description
-    complexVector obtained from generic Vector.
+    A Vector of complex values with 'scalar' precision.
 
 SourceFiles
     complexVectorI.H
@@ -48,6 +48,7 @@ namespace Foam
     typedef Vector<complex> complexVector;
 }
 
+// Functions
 #include "complexVectorI.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/primitives/Vector/complexVector/complexVectorI.H

@@ -23,10 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Description
-    complexVector specific part of 3D complexVector obtained from
-    generic Vector.
-
 \*---------------------------------------------------------------------------*/
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
@@ -34,7 +30,7 @@ Description
 namespace Foam
 {
 
-// * * * * * * * * * * * * * * * Friend Operators  * * * * * * * * * * * * * //
+// * * * * * * * * * * * * * * * Global Operators  * * * * * * * * * * * * * //
 
 inline complexVector operator*(const complex& v1, const complexVector& v2)
 {
@@ -80,8 +76,7 @@ inline complexVector operator/(const complex& v1, const complexVector& v2)
 }
 
 
-// complexVector dot product
-
+//- Dot product for complexVector
 inline complex operator&(const complexVector& v1, const complexVector& v2)
 {
     return complex
@@ -93,8 +88,7 @@ inline complex operator&(const complexVector& v1, const complexVector& v2)
 }
 
 
-// complexVector cross product
-
+//- Cross product for complexVector
 inline complexVector operator^(const complexVector& v1, const complexVector& v2)
 {
     return complexVector
@@ -106,8 +100,7 @@ inline complexVector operator^(const complexVector& v1, const complexVector& v2)
 }
 
 
-// complexVector cross product
-
+//- Cross product for complexVector
 inline complexVector operator^(const vector& v1, const complexVector& v2)
 {
     return complexVector

src/OpenFOAM/primitives/complex/complex.C

@@ -32,7 +32,7 @@ License
 
 const char* const Foam::complex::typeName = "complex";
 const Foam::complex Foam::complex::zero(0, 0);
-const Foam::complex Foam::complex::one(1, 1);
+const Foam::complex Foam::complex::one(1, 0);
 
 
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

src/OpenFOAM/primitives/complex/complex.H

@@ -98,7 +98,7 @@ public:
         //- A complex zero (0,0)
         static const complex zero;
 
-        //- A complex one (1,1)
+        //- A complex one (1,0)
         static const complex one;
 
 
@@ -189,12 +189,6 @@ public:
         inline void operator*=(const scalar s);
         inline void operator/=(const scalar s);
 
-        //- Conjugate
-        inline complex operator~() const;
-
-        //- Conjugate
-        inline complex operator!() const;
-
         inline bool operator==(const complex& c) const;
         inline bool operator!=(const complex& c) const;
 
@@ -244,6 +238,12 @@ template<>
 inline bool contiguous<complex>() {return true;}
 
 
+// * * * * * * * * * * * * * * * Global Operators  * * * * * * * * * * * * * //
+
+//- Complex conjugate
+inline complex operator~(const complex& c);
+
+
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 } // End namespace Foam

src/OpenFOAM/primitives/complex/complexI.H

@@ -174,18 +174,6 @@ inline void Foam::complex::operator/=(const scalar s)
 }
 
 
-inline Foam::complex Foam::complex::operator~() const
-{
-    return conjugate();
-}
-
-
-inline Foam::complex Foam::complex::operator!() const
-{
-    return conjugate();
-}
-
-
 inline bool Foam::complex::operator==(const complex& c) const
 {
     return (equal(re, c.re) && equal(im, c.im));
@@ -198,6 +186,14 @@ inline bool Foam::complex::operator!=(const complex& c) const
 }
 
 
+// * * * * * * * * * * * * * * * Global Operators  * * * * * * * * * * * * * //
+
+inline Foam::complex Foam::operator~(const complex& c)
+{
+    return c.conjugate();
+}
+
+
 // * * * * * * * * * * * * * * * Friend Functions  * * * * * * * * * * * * * //