Make TokamakCoordinatesFactory.normalise() private and call in make_t…

…okamak_coordinates() method
tomc271 · Dec 4, 2024 · f04cea5 · f04cea5
1 parent ae7f55f
commit f04cea5
Show file tree

Hide file tree

Showing 15 changed files with 46 additions and 50 deletions.
diff --git a/examples/6field-simple/elm_6f.cxx b/examples/6field-simple/elm_6f.cxx
@@ -835,8 +835,6 @@ class Elm_6f : public PhysicsModel {
     J0 = SI::mu0 * Lbar * J0 / tokamak_coordinates_factory.get_Bxy();
     P0 = P0 / (SI::kb * (Tibar + Tebar) * eV_K / 2. * Nbar * density);
 
-    tokamak_coordinates_factory.normalise(Lbar, Bbar);
-
     b0xcv.x /= Bbar;
     b0xcv.y *= Lbar * Lbar;
     b0xcv.z *= Lbar * Lbar;
@@ -906,7 +904,10 @@ class Elm_6f : public PhysicsModel {
         q95 = q95_input; // use a constant for test
       } else {
         if (local_q) {
-          q95 = abs(tokamak_coordinates_factory.get_hthe() * tokamak_coordinates_factory.get_Btxy() / tokamak_coordinates_factory.get_Bpxy()) * q_alpha;
+          q95 = abs(tokamak_coordinates_factory.get_hthe()
+                    * tokamak_coordinates_factory.get_Btxy()
+                    / tokamak_coordinates_factory.get_Bpxy())
+                * q_alpha;
         } else {
           output.write("\tUsing q profile from grid.\n");
           if (mesh->get(q95, "q")) {
@@ -1028,8 +1029,9 @@ class Elm_6f : public PhysicsModel {
     }
 
     /**************** CALCULATE METRICS ******************/
-    const auto& coord = tokamak_coordinates_factory.make_tokamak_coordinates(noshear);
-
+    const auto& coord =
+        tokamak_coordinates_factory.make_tokamak_coordinates(noshear, Lbar, Bbar);
+
     //////////////////////////////////////////////////////////////
     // SHIFTED RADIAL COORDINATES
 
@@ -1191,6 +1193,7 @@ class Elm_6f : public PhysicsModel {
 
     return 0;
   }
+
   int rhs(BoutReal UNUSED(t)) override {
 
     Coordinates* coord = mesh->getCoordinates();

diff --git a/examples/conducting-wall-mode/cwm.cxx b/examples/conducting-wall-mode/cwm.cxx
@@ -129,8 +129,8 @@ class CWM : public PhysicsModel {
     Te0 /= Te_x;
 
     // Normalise geometry
-    tokamak_coordinates_factory.normalise(rho_s, bmag / 1e4, ShearFactor);
-    coord = tokamak_coordinates_factory.make_tokamak_coordinates(noshear);
+    coord = tokamak_coordinates_factory.make_tokamak_coordinates(noshear, rho_s,
+                                                                 bmag / 1e4, ShearFactor);
 
     // Set nu
     nu = nu_hat * Ni0 / pow(Te0, 1.5);

diff --git a/examples/constraints/alfven-wave/alfven.cxx b/examples/constraints/alfven-wave/alfven.cxx
@@ -171,8 +171,8 @@ class Alfven : public PhysicsModel {
     }
 
     auto tokamak_coordinates_factory = TokamakCoordinatesFactory(*mesh);
-    tokamak_coordinates_factory.normalise(Lnorm, Bnorm);
-    const auto& coord = tokamak_coordinates_factory.make_tokamak_coordinates(noshear);
+    const auto& coord =
+        tokamak_coordinates_factory.make_tokamak_coordinates(noshear, Lnorm, Bnorm);
   }
 };
 

diff --git a/examples/dalf3/dalf3.cxx b/examples/dalf3/dalf3.cxx
@@ -222,8 +222,8 @@ class DALF3 : public PhysicsModel {
     b0xcv.z *= rho_s * rho_s;
 
     // Metrics
-    tokamak_coordinates_factory.normalise(rho_s, Bnorm);
-    const auto& coord = tokamak_coordinates_factory.make_tokamak_coordinates(noshear);
+    const auto& coord =
+        tokamak_coordinates_factory.make_tokamak_coordinates(noshear, rho_s, Bnorm);
 
     SOLVE_FOR3(Vort, Pe, Vpar);
     comms.add(Vort, Pe, Vpar);

diff --git a/examples/elm-pb-outerloop/elm_pb_outerloop.cxx b/examples/elm-pb-outerloop/elm_pb_outerloop.cxx
@@ -716,8 +716,7 @@ class ELMpb : public PhysicsModel {
     if (mesh->get(Lbar, "rmag") != 0) { // Typical length scale
       Lbar = 1.0;
     }
-    tokamak_coordinates_factory.normalise(Lbar, Bbar);
-    const auto& metric = tokamak_coordinates_factory.make_tokamak_coordinates(noshear);
+    const auto& metric = tokamak_coordinates_factory.make_tokamak_coordinates(noshear, Lbar, Bbar);
 
     V0 = -tokamak_coordinates_factory.get_Rxy() * tokamak_coordinates_factory.get_Bpxy() * Dphi0 / tokamak_coordinates_factory.get_Bxy();
 

diff --git a/examples/elm-pb/elm_pb.cxx b/examples/elm-pb/elm_pb.cxx
@@ -876,8 +876,7 @@ class ELMpb : public PhysicsModel {
     b0xcv.y *= Lbar * Lbar;
     b0xcv.z *= Lbar * Lbar;
 
-    tokamak_coordinates_factory.normalise(Lbar, Bbar);
-    const auto& metric = tokamak_coordinates_factory.make_tokamak_coordinates(noshear);
+    const auto& metric = tokamak_coordinates_factory.make_tokamak_coordinates(noshear, Lbar, Bbar);
 
 
     //////////////////////////////////////////////////////////////

diff --git a/examples/gyro-gem/gem.cxx b/examples/gyro-gem/gem.cxx
@@ -252,8 +252,7 @@ class GEM : public PhysicsModel {
     Bbar = options["Bbar"].withDefault(Bbar); // Override in options file
     SAVE_ONCE(Bbar);
 
-    tokamak_coordinates_factory.normalise(Lbar, Bbar);
-    coord = tokamak_coordinates_factory.make_tokamak_coordinates(true);
+    coord = tokamak_coordinates_factory.make_tokamak_coordinates(true, Lbar, Bbar);
 
     beta_e = 4.e-7 * PI * max(p_e, true) / (Bbar * Bbar);
     SAVE_ONCE(beta_e);

diff --git a/examples/laplacexy/alfven-wave/alfven.cxx b/examples/laplacexy/alfven-wave/alfven.cxx
@@ -173,8 +173,8 @@ class Alfven : public PhysicsModel {
 
 
     auto tokamak_coordinates_factory = TokamakCoordinatesFactory(*mesh);
-    tokamak_coordinates_factory.normalise(Lnorm, Bnorm);
-    const auto& coord = tokamak_coordinates_factory.make_tokamak_coordinates(true);
+    const auto& coord =
+        tokamak_coordinates_factory.make_tokamak_coordinates(true, Lnorm, Bnorm);
   }
 };
 

diff --git a/include/bout/tokamak_coordinates_factory.hxx b/include/bout/tokamak_coordinates_factory.hxx
@@ -3,17 +3,16 @@
 #define BOUT_TOKAMAK_COORDINATES_FACTORY_HXX
 
 #include "bout.hxx"
-#include "bout/utils.hxx"
 #include "bout/bout_types.hxx"
 #include "bout/christoffel_symbols.hxx"
-#include "bout/vector2d.hxx"
-#include "bout/field2d.hxx"
 #include "bout/coordinates.hxx"
+#include "bout/field2d.hxx"
+#include "bout/utils.hxx"
+#include "bout/vector2d.hxx"
 
 class TokamakCoordinatesFactory {
 
 private:
-
   Mesh& mesh_m;
   Field2D Rxy_m;
   Field2D Bpxy_m;
@@ -23,11 +22,19 @@ private:
   FieldMetric ShearFactor_m;
   FieldMetric dx_m;
 
+  void normalise(BoutReal Lbar, BoutReal Bbar, BoutReal ShearFactor) {
 
-public:
+    Rxy_m /= Lbar;
+    Bpxy_m /= Bbar;
+    Btxy_m /= Bbar;
+    Bxy_m /= Bbar;
+    hthe_m /= Lbar;
+    ShearFactor_m *= Lbar * Lbar * Bbar * ShearFactor;
+    dx_m /= Lbar * Lbar * Bbar;
+  }
 
-  TokamakCoordinatesFactory(Mesh& mesh)
-      : mesh_m(mesh) {
+public:
+  TokamakCoordinatesFactory(Mesh& mesh) : mesh_m(mesh) {
 
     mesh.get(Rxy_m, "Rxy");
     //    mesh->get(Zxy, "Zxy");
@@ -46,7 +53,10 @@ public:
     return 1.0;
   }
 
-  Coordinates* make_tokamak_coordinates(const bool noshear) {
+  Coordinates* make_tokamak_coordinates(const bool noshear, BoutReal Lbar, BoutReal Bbar,
+                                        BoutReal ShearFactor = 1.0) {
+
+    normalise(Lbar, Bbar, ShearFactor);
 
     const BoutReal sign_of_bp = get_sign_of_bp();
 
@@ -80,17 +90,6 @@ public:
     return coord;
   }
 
-  void normalise(BoutReal Lbar, BoutReal Bbar, BoutReal ShearFactor=1.0) {
-
-    Rxy_m /= Lbar;
-    Bpxy_m /= Bbar;
-    Btxy_m /= Bbar;
-    Bxy_m /= Bbar;
-    hthe_m /= Lbar;
-    ShearFactor_m *= Lbar * Lbar * Bbar * ShearFactor;
-    dx_m /= Lbar * Lbar * Bbar;
-  }
-
   const Field2D& get_Rxy() const { return Rxy_m; }
   const Field2D& get_Bpxy() const { return Bpxy_m; }
   const Field2D& get_Btxy() const { return Btxy_m; }

diff --git a/tests/MMS/GBS/gbs.cxx b/tests/MMS/GBS/gbs.cxx
@@ -316,8 +316,7 @@ int GBS::init(bool restarting) {
 void GBS::LoadMetric(BoutReal Lnorm, BoutReal Bnorm) {
 
   auto tokamak_coordinates_factory = TokamakCoordinatesFactory(*mesh);
-  tokamak_coordinates_factory.normalise(Lnorm, Bnorm);
-  coords = tokamak_coordinates_factory.make_tokamak_coordinates(true);
+  coords = tokamak_coordinates_factory.make_tokamak_coordinates(true, Lnorm, Bnorm);
 
 // just define a macro for V_E dot Grad
 #define vE_Grad(f, p) (bracket(p, f, bm_exb))

diff --git a/tests/MMS/elm-pb/elm_pb.cxx b/tests/MMS/elm-pb/elm_pb.cxx
@@ -390,8 +390,7 @@ class ELMpb : public PhysicsModel {
       noshear = true;
     }
 
-    tokamak_coordinates_factory.normalise(Lbar, Bbar);
-    coords = tokamak_coordinates_factory.make_tokamak_coordinates(noshear);
+    coords = tokamak_coordinates_factory.make_tokamak_coordinates(noshear, Lbar, Bbar);
 
     //////////////////////////////////////////////////////////////
     // SHIFTED RADIAL COORDINATES

diff --git a/tests/MMS/tokamak/tokamak.cxx b/tests/MMS/tokamak/tokamak.cxx
@@ -46,8 +46,8 @@ class TokamakMMS : public PhysicsModel {
   void LoadMetric(BoutReal Lnorm, BoutReal Bnorm) {
 
     auto tokamak_coordinates_factory = TokamakCoordinatesFactory(*mesh);
-    tokamak_coordinates_factory.normalise(Lnorm, Bnorm);
-    auto coords = tokamak_coordinates_factory.make_tokamak_coordinates(true);
+    auto coords =
+        tokamak_coordinates_factory.make_tokamak_coordinates(true, Lnorm, Bnorm);
   }
 
 private:

diff --git a/tests/integrated/test-drift-instability/2fluid.cxx b/tests/integrated/test-drift-instability/2fluid.cxx
@@ -193,8 +193,8 @@ class TwoFluid : public PhysicsModel {
     pei0 = (Ti0 + Te0) * Ni0;
     pe0 = Te0 * Ni0;
 
-    tokamak_coordinates_factory.normalise(rho_s, bmag / 1e4, ShearFactor);
-    coord = tokamak_coordinates_factory.make_tokamak_coordinates(noshear);
+    coord = tokamak_coordinates_factory.make_tokamak_coordinates(noshear, rho_s,
+                                                                 bmag / 1e4, ShearFactor);
 
     /**************** SET EVOLVING VARIABLES *************/
 

diff --git a/tests/integrated/test-interchange-instability/2fluid.cxx b/tests/integrated/test-interchange-instability/2fluid.cxx
@@ -100,8 +100,8 @@ class Interchange : public PhysicsModel {
           hthe0 / rho_s);
     }
 
-    tokamak_coordinates_factory.normalise(rho_s, bmag / 1e4, ShearFactor);
-    coord = tokamak_coordinates_factory.make_tokamak_coordinates(noshear);
+    coord = tokamak_coordinates_factory.make_tokamak_coordinates(noshear, rho_s,
+                                                                 bmag / 1e4, ShearFactor);
 
     if (ShiftXderivs) {
       b0xcv.z += tokamak_coordinates_factory.get_ShearFactor() * b0xcv.x;

diff --git a/tests/integrated/test-laplacexy/loadmetric.cxx b/tests/integrated/test-laplacexy/loadmetric.cxx
@@ -18,6 +18,5 @@ void LoadMetric(BoutReal Lnorm, BoutReal Bnorm) {
   }
 
   auto tokamak_coordinates_factory = TokamakCoordinatesFactory(*mesh);
-  tokamak_coordinates_factory.normalise(Lnorm, Bnorm);
-  auto coords = tokamak_coordinates_factory.make_tokamak_coordinates(noshear);
+  auto coords = tokamak_coordinates_factory.make_tokamak_coordinates(noshear, Lnorm, Bnorm);
 }