Make MetricTensor abstract (by making calcCovariant() and calcContrav…

…ariant() implementations of CalculateOppositeRepresentation()).
tomc271 · Nov 6, 2023 · 62a287b · 62a287b
1 parent 6f67ca2
commit 62a287b
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 20 deletions.
diff --git a/include/bout/contravariantMetricTensor.hxx b/include/bout/contravariantMetricTensor.hxx
@@ -14,9 +14,11 @@ public:
   ContravariantMetricTensor(const BoutReal g11, const BoutReal g22, const BoutReal g33,
                             const BoutReal g12, const BoutReal g13, const BoutReal g23,
                             Mesh* mesh);
+
   /// Invert covariant metric to get contravariant components
-  void calcContravariant(CovariantMetricTensor covariantMetricTensor, CELL_LOC location,
-                         const std::string& region = "RGN_ALL");
+  void CalculateOppositeRepresentation(MetricTensor& covariantMetricTensor,
+                                       CELL_LOC location,
+                                       const std::string& region = "RGN_ALL") override;
 };
 
 #endif //BOUT_CONTRAVARIANTMETRICTENSOR_HXX
diff --git a/include/bout/covariantMetricTensor.hxx b/include/bout/covariantMetricTensor.hxx
@@ -14,9 +14,11 @@ public:
   CovariantMetricTensor(const BoutReal g_11, const BoutReal g_22, const BoutReal g_33,
                         const BoutReal g_12, const BoutReal g_13, const BoutReal g_23,
                         Mesh* mesh);
+
   /// Invert contravariant metric to get covariant components
-  void calcCovariant(ContravariantMetricTensor contravariantMetricTensor,
-                     CELL_LOC location, const std::string& region = "RGN_ALL");
+  void CalculateOppositeRepresentation(MetricTensor& contravariantMetricTensor,
+                                       const CELL_LOC location,
+                                       const std::string& region = "RGN_ALL") override;
 };
 
 #endif //BOUT_COVARIANTMETRICTENSOR_HXX
diff --git a/include/bout/metricTensor.hxx b/include/bout/metricTensor.hxx
@@ -17,7 +17,6 @@ public:
   using FieldMetric = Field2D;
 #endif
 
-  MetricTensor();
   MetricTensor(const FieldMetric& g11, const FieldMetric& g22, const FieldMetric& g33,
                const FieldMetric& g12, const FieldMetric& g13, const FieldMetric& g23);
 
@@ -40,6 +39,10 @@ public:
 
   void setLocation(const CELL_LOC location);
 
+  virtual void CalculateOppositeRepresentation(MetricTensor& covariantMetricTensor,
+                                               CELL_LOC location,
+                                               const std::string& region) = 0;
+
 protected:
   FieldMetric g11, g22, g33, g12, g13, g23;
 };

diff --git a/src/mesh/contravariantMetricTensor.cxx b/src/mesh/contravariantMetricTensor.cxx
@@ -13,11 +13,10 @@ ContravariantMetricTensor::ContravariantMetricTensor(
     const BoutReal g13, const BoutReal g23, Mesh* mesh)
     : MetricTensor::MetricTensor(g11, g22, g33, g12, g13, g23, mesh) {}
 
-void ContravariantMetricTensor::calcContravariant(
-    CovariantMetricTensor covariantMetricTensor, CELL_LOC location,
-    const std::string& region) {
+void ContravariantMetricTensor::CalculateOppositeRepresentation(
+    MetricTensor& covariantMetricTensor, CELL_LOC location, const std::string& region) {
 
-  TRACE("ContravariantMetricTensor::calcContravariant");
+  TRACE("ContravariantMetricTensor::CalculateOppositeRepresentation");
 
   // Perform inversion of g{ij} to get g^{ij}
   // NOTE: Currently this bit assumes that metric terms are Field2D objects

diff --git a/src/mesh/coordinates.cxx b/src/mesh/coordinates.cxx
@@ -1386,14 +1386,16 @@ void Coordinates::CalculateChristoffelSymbols() {
 }
 
 CovariantMetricTensor Coordinates::calcCovariant(const std::string& region) {
-  TRACE("Coordinates::calcCovariant");
-  covariantMetricTensor.calcCovariant(contravariantMetricTensor, location, region);
+  TRACE("Coordinates::CalculateOppositeRepresentation");
+  covariantMetricTensor.CalculateOppositeRepresentation(contravariantMetricTensor,
+                                                        location, region);
   return covariantMetricTensor;
 }
 
 ContravariantMetricTensor Coordinates::calcContravariant(const std::string& region) {
-  TRACE("Coordinates::calcContravariant");
-  contravariantMetricTensor.calcContravariant(covariantMetricTensor, location, region);
+  TRACE("Coordinates::CalculateOppositeRepresentation");
+  contravariantMetricTensor.CalculateOppositeRepresentation(covariantMetricTensor,
+                                                            location, region);
   return contravariantMetricTensor;
 }
 
@@ -2013,7 +2015,8 @@ void Coordinates::checkContravariant() {
 void Coordinates::setMetricTensor(ContravariantMetricTensor metric_tensor,
                                   const std::string& region) {
   contravariantMetricTensor.setMetricTensor(metric_tensor);
-  covariantMetricTensor.calcCovariant(contravariantMetricTensor, location, region);
+  covariantMetricTensor.CalculateOppositeRepresentation(contravariantMetricTensor,
+                                                        location, region);
 }
 
 const CovariantMetricTensor::FieldMetric& Coordinates::g_11() const {
@@ -2056,5 +2059,6 @@ const ContravariantMetricTensor::FieldMetric& Coordinates::g23() const {
 
 void Coordinates::setMetricTensor(CovariantMetricTensor metric_tensor) {
   covariantMetricTensor.setMetricTensor(metric_tensor);
-  contravariantMetricTensor.calcContravariant(covariantMetricTensor, location);
+  contravariantMetricTensor.CalculateOppositeRepresentation(covariantMetricTensor,
+                                                            location);
 }
diff --git a/src/mesh/covariantMetricTensor.cxx b/src/mesh/covariantMetricTensor.cxx
@@ -15,10 +15,10 @@ CovariantMetricTensor::CovariantMetricTensor(const BoutReal g_11, const BoutReal
                                              Mesh* mesh)
     : MetricTensor::MetricTensor(g_11, g_22, g_33, g_12, g_13, g_23, mesh) {}
 
-void CovariantMetricTensor::calcCovariant(
-    ContravariantMetricTensor contravariantMetricTensor, const CELL_LOC location,
+void CovariantMetricTensor::CalculateOppositeRepresentation(
+    MetricTensor& contravariantMetricTensor, const CELL_LOC location,
     const std::string& region) {
-  TRACE("CovariantMetricTensor::calcCovariant");
+  TRACE("CovariantMetricTensor::CalculateOppositeRepresentation");
 
   // Perform inversion of g^{ij} to get g{ij}
   // NOTE: Currently this bit assumes that metric terms are Field2D objects

diff --git a/tools/pylib/_boutpp_build/boutcpp.pxd.jinja b/tools/pylib/_boutpp_build/boutcpp.pxd.jinja
@@ -79,8 +79,8 @@ cdef extern from "bout/coordinates.hxx":
         {{ metric_field }} ShiftTorsion
         {{ metric_field }} IntShiftTorsion
         int geometry()
-        int calcCovariant()
-        int calcContravariant()
+        int CalculateOppositeRepresentation()
+        int CalculateOppositeRepresentation()
         int jacobian()
 
 cdef extern from "bout/fieldgroup.hxx":