Merge pull request #3323 from boutproject/communicate-fieldperp-v2

Communicate `FieldPerp` consistently with other Fields

Author: ZedThree

include/bout/field2d.hxx

@@ -252,8 +252,7 @@ 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
   void doneComms() override { bndry_xin = bndry_xout = bndry_yup = bndry_ydown = true; }

include/bout/field3d.hxx

@@ -474,7 +474,7 @@ public:
   ///@}
 
   // FieldData virtual functions
-  bool is3D() const override { return true; }
+  FieldType field_type() const override { return FieldType::field3d; }
 
 #if CHECK > 0
   void doneComms() override { bndry_xin = bndry_xout = bndry_yup = bndry_ydown = true; }

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/fieldgroup.hxx

@@ -1,34 +1,33 @@
 #ifndef BOUT_FIELDGROUP_H
 #define BOUT_FIELDGROUP_H
 
-#include "bout/field_data.hxx"
-#include <bout/field3d.hxx>
-
+#include <bout/traits.hxx>
 #include <bout/vector2d.hxx>
 #include <bout/vector3d.hxx>
 
 #include <vector>
 
-#include <algorithm>
+class Field2D;
+class Field3D;
+class FieldPerp;
+class Field;
 
 /// Group together fields for easier communication
 ///
-/// Note: The FieldData class is used as a base class,
-/// which is inherited by Field2D, Field3D, Vector2D and Vector3D
-/// however Vector2D and Vector3D are stored by reference to their
-/// components (x,y,z) as Field2D or Field3D objects.
+/// Note: The `Field` class is used as a base class,
+/// which is inherited by `Field2D`, `Field3D`, `FieldPerp`;
+/// however `Vector2D` and `Vector3D` are stored by reference to their
+/// components ``(x, y, z)`` as `Field2D` or `Field3D` objects.
 class FieldGroup {
 public:
   FieldGroup() = default;
   FieldGroup(const FieldGroup& other) = default;
   FieldGroup(FieldGroup&& other) = default;
   FieldGroup& operator=(const FieldGroup& other) = default;
   FieldGroup& operator=(FieldGroup&& other) = default;
+  ~FieldGroup() = default;
 
-  /// Constructor with a single FieldData \p f
-  FieldGroup(FieldData& f) { fvec.push_back(&f); }
-
-  /// Constructor with a single Field3D \p f
+  FieldGroup(Field& f) { fvec.push_back(&f); }
   FieldGroup(Field3D& f) {
     fvec.push_back(&f);
     f3vec.push_back(&f);
@@ -56,7 +55,7 @@ public:
   }
 
   /// Variadic constructor. Allows an arbitrary number of
-  /// FieldData arguments
+  /// Field arguments
   ///
   /// The explicit keyword prevents FieldGroup being constructed with arbitrary
   /// types. In particular arguments to add() cannot be implicitly converted
@@ -78,12 +77,12 @@ public:
     return *this;
   }
 
-  /// Add a FieldData \p f to the group.
+  /// Add a Field \p f to the group.
   ///
   /// A pointer to this field will be stored internally,
   /// so the lifetime of this variable should be longer
   /// than the lifetime of this group.
-  void add(FieldData& f) { fvec.push_back(&f); }
+  void add(Field& f) { fvec.push_back(&f); }
 
   // Add a 3D field \p f, which goes into both vectors.
   //
@@ -121,12 +120,8 @@ public:
   }
 
   /// Add multiple fields to this group
-  ///
-  /// This is a variadic template which allows Field3D objects to be
-  /// treated as a special case. An arbitrary number of fields can be
-  /// added.
   template <typename... Ts>
-  void add(FieldData& t, Ts&... ts) {
+  void add(Field& t, Ts&... ts) {
     add(t);     // Add the first using functions above
     add(ts...); // Add the rest
   }
@@ -165,16 +160,14 @@ public:
   }
 
   /// Iteration over all fields
-  using iterator = std::vector<FieldData*>::iterator;
-  iterator begin() { return fvec.begin(); }
-  iterator end() { return fvec.end(); }
+  auto begin() { return fvec.begin(); }
+  auto end() { return fvec.end(); }
 
   /// Const iteration over all fields
-  using const_iterator = std::vector<FieldData*>::const_iterator;
-  const_iterator begin() const { return fvec.begin(); }
-  const_iterator end() const { return fvec.end(); }
+  auto begin() const { return fvec.cbegin(); }
+  auto end() const { return fvec.cend(); }
 
-  const std::vector<FieldData*>& get() const { return fvec; }
+  const std::vector<Field*>& get() const { return fvec; }
 
   /// Iteration over 3D fields
   const std::vector<Field3D*>& field3d() const { return f3vec; }
@@ -183,8 +176,8 @@ public:
   void makeUnique();
 
 private:
-  std::vector<FieldData*> fvec; // Vector of fields
-  std::vector<Field3D*> f3vec;  // Vector of 3D fields
+  std::vector<Field*> fvec;    // Vector of fields
+  std::vector<Field3D*> f3vec; // Vector of 3D fields
 };
 
 /// Combine two FieldGroups

include/bout/fieldperp.hxx

@@ -303,7 +303,7 @@ 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/mesh.hxx

@@ -63,6 +63,7 @@ class Mesh;
 #include <optional>
 #include <set>
 #include <string>
+#include <vector>
 
 class BoundaryRegion;
 class BoundaryRegionPar;
@@ -299,11 +300,6 @@ public:
   /// @param g  The group of fields to communicate. Guard cells will be modified
   void communicateYZ(FieldGroup& g);
 
-  /*!
-   * Communicate an X-Z field
-   */
-  virtual void communicate(FieldPerp& f);
-
   /*!
    * Send a list of FieldData objects
    * Packs arguments into a FieldGroup and passes
@@ -814,8 +810,8 @@ protected:
   const std::vector<int> readInts(const std::string& name, int n);
 
   /// Calculates the size of a message for a given x and y range
-  int msg_len(const std::vector<FieldData*>& var_list, int xge, int xlt, int yge,
-              int ylt);
+  int msg_len(const std::vector<Field*>& var_list, int xge, int xlt, int yge,
+              int ylt) const;
 
   /// Initialise derivatives
   void derivs_init(Options* options);

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");