Move field_type() to FieldData; deprecate FieldData::is3D()

Author: ZedThree

include/bout/field.hxx

@@ -30,7 +30,6 @@ class Field;
 #define FIELD_H
 
 #include <cmath>
-#include <cstdint>
 #include <cstdio>
 #include <optional>
 #include <string>
@@ -121,11 +120,6 @@ public:
   /// Get the total number of points
   virtual int size() const = 0;
 
-  /// Enum to distinguish the different kinds of Fields
-  enum class FieldType : std::uint8_t { field3d, field2d, fieldperp };
-  /// Is this an instance of `Field3D`, `Field2D`, or `FieldPerp`?
-  virtual FieldType field_type() const = 0;
-
   friend void swap(Field& first, Field& second) noexcept {
     using std::swap;
     swap(static_cast<FieldData&>(first), static_cast<FieldData&>(second));

include/bout/field2d.hxx

@@ -250,8 +250,6 @@ public:
   Field2D& operator/=(BoutReal rhs);
 
   // FieldData virtual functions
-
-  bool is3D() const override { return false; }
   FieldType field_type() const override { return FieldType::field2d; }
 
 #if CHECK > 0

include/bout/field3d.hxx

@@ -473,7 +473,6 @@ public:
   ///@}
 
   // FieldData virtual functions
-  bool is3D() const override { return true; }
   FieldType field_type() const override { return FieldType::field3d; }
 
 #if CHECK > 0

include/bout/field_data.hxx

@@ -6,7 +6,7 @@
  * Copyright 2010 B.D.Dudson, S.Farley, M.V.Umansky, X.Q.Xu
  *
  * Contact: Ben Dudson, bd512@york.ac.uk
- * 
+ *
  * This file is part of BOUT++.
  *
  * BOUT++ is free software: you can redistribute it and/or modify
@@ -33,6 +33,7 @@ class FieldData;
 #include "bout/bout_types.hxx"
 #include "bout/unused.hxx"
 
+#include <cstdint>
 #include <map>
 #include <memory>
 #include <string>
@@ -71,13 +72,22 @@ public:
   /// Get variable location
   virtual CELL_LOC getLocation() const;
 
+  /// Enum to distinguish the different kinds of Fields
+  enum class FieldType : std::uint8_t { field3d, field2d, fieldperp };
+  /// Is this an instance of `Field3D`, `Field2D`, or `FieldPerp`?
+  virtual FieldType field_type() const = 0;
+
   // Defines interface which must be implemented
   /// True if variable is 3D
-  virtual bool is3D() const = 0;
+  [[deprecated("Use `field_type()` instead")]]
+  bool is3D() const {
+    return field_type() == FieldType::field3d;
+  }
+
   /// Number of BoutReals in one element
   virtual int elementSize() const { return 1; }
 
-  virtual void doneComms(){}; // Notifies that communications done
+  virtual void doneComms() {}; // Notifies that communications done
 
   // Boundary conditions
   void setBoundary(const std::string& name); ///< Set the boundary conditions
@@ -86,13 +96,13 @@ public:
   copyBoundary(const FieldData& f); ///< Copy the boundary conditions from another field
 
   virtual void applyBoundary(bool UNUSED(init) = false) {}
-  virtual void applyTDerivBoundary(){};
+  virtual void applyTDerivBoundary() {};
 
-  virtual void applyParallelBoundary(){};
-  virtual void applyParallelBoundary(BoutReal UNUSED(t)){};
-  virtual void applyParallelBoundary(const std::string& UNUSED(condition)){};
+  virtual void applyParallelBoundary() {};
+  virtual void applyParallelBoundary(BoutReal UNUSED(t)) {};
+  virtual void applyParallelBoundary(const std::string& UNUSED(condition)) {};
   virtual void applyParallelBoundary(const std::string& UNUSED(region),
-                                     const std::string& UNUSED(condition)){};
+                                     const std::string& UNUSED(condition)) {};
   // JMAD
   void addBndryFunction(FuncPtr userfunc, BndryLoc location);
   void addBndryGenerator(FieldGeneratorPtr gen, BndryLoc location);

include/bout/fieldperp.hxx

@@ -300,7 +300,6 @@ public:
    */
   int getNz() const override { return nz; };
 
-  bool is3D() const override { return false; }
   FieldType field_type() const override { return FieldType::fieldperp; }
 
   friend void swap(FieldPerp& first, FieldPerp& second) noexcept;

include/bout/vector2d.hxx

@@ -13,7 +13,7 @@
  * Copyright 2010 B.D.Dudson, S.Farley, M.V.Umansky, X.Q.Xu
  *
  * Contact: Ben Dudson, bd512@york.ac.uk
- * 
+ *
  * This file is part of BOUT++.
  *
  * BOUT++ is free software: you can redistribute it and/or modify
@@ -142,7 +142,7 @@ public:
   CELL_LOC getLocation() const override;
 
   // FieldData virtual functions
-  bool is3D() const override { return false; }
+  FieldType field_type() const override { return FieldType::field2d; }
   int elementSize() const override { return 3; }
 
   /// Apply boundary condition to all fields

include/bout/vector3d.hxx

@@ -9,7 +9,7 @@
  * Copyright 2010 B.D.Dudson, S.Farley, M.V.Umansky, X.Q.Xu
  *
  * Contact: Ben Dudson, bd512@york.ac.uk
- * 
+ *
  * This file is part of BOUT++.
  *
  * BOUT++ is free software: you can redistribute it and/or modify
@@ -45,10 +45,10 @@ class Vector2D;
  * -------
  *
  * Vector3D f;
- * 
+ *
  * a.x; // Error! a.x not allocated
  *
- * 
+ *
  */
 class Vector3D : public FieldData {
 public:
@@ -70,7 +70,7 @@ public:
   ~Vector3D() override;
 
   /*!
-   * The components of the vector. These can be 
+   * The components of the vector. These can be
    * either co- or contra-variant, depending on
    * the boolean flag "covariant"
    */
@@ -92,8 +92,8 @@ public:
   bool covariant{true};
 
   /*!
-   * In-place conversion to covariant form. 
-   * 
+   * In-place conversion to covariant form.
+   *
    * If already covariant (covariant = true) then does nothing
    * If contravariant, multiplies by metric tensor g_{ij}
    */
@@ -104,7 +104,7 @@ public:
    *
    * If already contravariant (covariant = false) then does nothing
    * If covariant, multiplies by metric tensor g^{ij}
-   * 
+   *
    */
   void toContravariant();
 
@@ -114,14 +114,14 @@ public:
    * The first time this is called, a new Vector3D object is created.
    * Subsequent calls return a pointer to this same object
    *
-   * For convenience, a standalone function "ddt" exists, so that 
+   * For convenience, a standalone function "ddt" exists, so that
    *
    * ddt(v) is equivalent to *(v.timeDeriv())
-   * 
+   *
    * This does some book-keeping to ensure that the time derivative
    * of the components is the same as the components of the time derivative
    *
-   * ddt(v).x == ddt(v.x) 
+   * ddt(v).x == ddt(v.x)
    */
   Vector3D* timeDeriv();
 
@@ -172,7 +172,7 @@ public:
   CELL_LOC getLocation() const override;
 
   // FieldData virtual functions
-  bool is3D() const override { return true; }
+  FieldType field_type() const override { return FieldType::field3d; }
   int elementSize() const override { return 3; }
 
   void applyBoundary(bool init = false) override;
@@ -203,7 +203,7 @@ const Vector3D cross(const Vector3D& lhs, const Vector2D& rhs);
 
 /*!
  * Absolute magnitude (modulus) of a vector  |v|
- * 
+ *
  * sqrt( v.x^2 + v.y^2 + v.z^2 )
  */
 const Field3D abs(const Vector3D& v, const std::string& region = "RGN_ALL");

tests/unit/field/test_field.cxx

@@ -24,7 +24,6 @@ class FieldSubClass : public Field {
   FieldSubClass(Mesh* localmesh, CELL_LOC location_in, DirectionTypes directions_in)
       : Field(localmesh, location_in, directions_in) {}
 
-  bool is3D() const override { return false; }
   int size() const override { return 42; }
   FieldType field_type() const override { return FieldType::field2d; }
 };

tests/unit/field/test_vector2d.cxx

@@ -97,12 +97,6 @@ TEST_F(Vector2DTest, ApplyBoundaryString) {
   EXPECT_DOUBLE_EQ(v.x(2, 2), 0.0);
 }
 
-TEST_F(Vector2DTest, Is3D) {
-  Vector2D vector;
-
-  EXPECT_FALSE(vector.is3D());
-}
-
 TEST_F(Vector2DTest, BoutRealSize) {
   Vector2D vector;
 

tests/unit/field/test_vector3d.cxx

@@ -100,12 +100,6 @@ TEST_F(Vector3DTest, ApplyBoundaryString) {
   EXPECT_DOUBLE_EQ(v.x(2, 2, 1), 0.0);
 }
 
-TEST_F(Vector3DTest, Is3D) {
-  Vector3D vector;
-
-  EXPECT_TRUE(vector.is3D());
-}
-
 TEST_F(Vector3DTest, BoutRealSize) {
   Vector3D vector;