note on capBpYlowXpoint has been added

boutproject · Sep 18, 2024 · bc2e893 · bc2e893
1 parent dabf4d0
commit bc2e893
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/hypnotoad/core/mesh.py b/hypnotoad/core/mesh.py
@@ -912,6 +912,9 @@ def geometry2(self):
             # (By default do _not_ do this)
             # Get rid of minimum in Bpxy.ylow field, because it can cause large spikes in
             # some metric coefficients, which may cause numerical problems in simulations
+            #
+            # note: capBpYlowXpoint assumes a positive definie Bp and doesnt work
+            #       with a negative definit Bp (H.Seto)
             self.capBpYlowXpoint()
 
         self.hy = self.calcHy()