From da7c1639453b60f1df046fc39cac468e82d7d089 Mon Sep 17 00:00:00 2001
From: Ben Dudson <dudson2@llnl.gov>
Date: Mon, 14 Aug 2023 23:28:10 -0700
Subject: [PATCH] Add tokamak option psi_divide_twopi

Some equilibrium codes write GEQDSK files with a factor of 2pi
in the poloidal flux, resulting in poloidal fields that are 2pi
too large. If this option `psi_divide_twopi` is set to `true`
then the input poloidal flux is divided by 2pi.
---
 hypnotoad/cases/tokamak.py | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/hypnotoad/cases/tokamak.py b/hypnotoad/cases/tokamak.py
index 03128b29..cb1989e2 100644
--- a/hypnotoad/cases/tokamak.py
+++ b/hypnotoad/cases/tokamak.py
@@ -38,6 +38,11 @@ class TokamakEquilibrium(Equilibrium):
             doc="Reverse the sign of the poloidal field",
             value_type=bool,
         ),
+        psi_divide_twopi=WithMeta(
+            False,
+            doc="Divide poloidal flux, and so poloidal field, by 2pi",
+            value_type=bool,
+        ),
         extrapolate_profiles=WithMeta(
             False,
             doc=(
@@ -364,6 +369,16 @@ def __init__(
             psi2D *= -1.0
             psi1D *= -1.0
 
+        if self.user_options.psi_divide_twopi:
+            warnings.warn("Dividing poloidal flux by 2pi")
+            twopi = 2 * np.pi
+            psi2D /= twopi
+            psi1D /= twopi
+            if psi_axis_gfile is not None:
+                psi_axis_gfile /= twopi
+            if psi_bdry_gfile is not None:
+                psi_bdry_gfile /= twopi
+
         if self.user_options.reverse_Bt:
             warnings.warn("Reversing the sign of the toroidal field")
             fpol1D *= -1.0
@@ -1679,6 +1694,7 @@ def read_geqdsk(
 
     * ``reverse_current = bool`` - Changes the sign of poloidal flux psi
     * ``extrapolate_profiles = bool`` - Extrapolate pressure using exponential
+    * ``psi_divide_twopi = bool`` - Divide poloidal flux, and so poloidal field, by 2pi
     """
 
     if settings is None: