tglf: elaborate on shear definition

gafusion · Nov 17, 2023 · 03ee8c4 · 03ee8c4
1 parent 924786e
commit 03ee8c4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/docs/tglf/tglf_list.html b/docs/tglf/tglf_list.html
@@ -211,7 +211,7 @@ <h1>Alphabetical list for input.tglf<a class="headerlink" href="#alphabetical-li
 <section id="alpha-zf">
 <span id="tglf-alpha-zf"></span><h2>ALPHA_ZF<a class="headerlink" href="#alpha-zf" title="Link to this heading"></a></h2>
 <p><strong>Definition</strong></p>
-<p>Zonal flow mixing coefficient (used by SAT1, SAT2, SAT3). Note: Can be used as hidden switch that avoids picking the lowest ky as the peak in gamma/ky when ALPHA_ZF=-1.0. This switch is useful when an MHD mode at the lowest ky causes a large amount of flux.</p>
+<p>Zonal flow mixing coefficient (used by SAT1, SAT2, SAT3). Note: Can be used as hidden switch that avoids picking unphysically low ky as the peak in gamma/ky when ALPHA_ZF=-1.0. This switch is useful when an MHD mode at the lowest ky causes a large amount of flux.</p>
 <p><strong>Comments</strong></p>
 <ul class="simple">
 <li><p>DEFAULT = 1.0</p></li>
@@ -743,7 +743,7 @@ <h1>Alphabetical list for input.tglf<a class="headerlink" href="#alphabetical-li
 <section id="shat-sa">
 <span id="tglf-shat-sa"></span><h2>SHAT_SA<a class="headerlink" href="#shat-sa" title="Link to this heading"></a></h2>
 <p><strong>Definition</strong></p>
-<p>Magnetic shear <span class="math notranslate nohighlight">\({\frac {r}{q}}{\frac {\partial q}{\partial r}}\)</span>.</p>
+<p>Magnetic shear <span class="math notranslate nohighlight">\({\frac {r}{q}}{\frac {\partial q}{\partial r}}\)</span>. Caution: Only used for <span class="math notranslate nohighlight">\(s-\alpha\)</span> geometry (GEOMETRY_FLAG = 0), otherwise see Q_PRIME_LOC.</p>
 <p><strong>Comments</strong></p>
 <ul class="simple">
 <li><p>DEFAULT = 1.0</p></li>

diff --git a/html/src/tglf/tglf_list.rst b/html/src/tglf/tglf_list.rst
@@ -43,7 +43,7 @@ ALPHA_ZF
 
 **Definition**
 
-Zonal flow mixing coefficient (used by SAT1, SAT2, SAT3). Note: Can be used as hidden switch that avoids picking the lowest ky as the peak in gamma/ky when ALPHA_ZF=-1.0. This switch is useful when an MHD mode at the lowest ky causes a large amount of flux.
+Zonal flow mixing coefficient (used by SAT1, SAT2, SAT3). Note: Can be used as hidden switch that avoids picking unphysically low ky as the peak in gamma/ky when ALPHA_ZF=-1.0. This switch is useful when an MHD mode at the lowest ky causes a large amount of flux.
 
 
 **Comments**
@@ -868,7 +868,7 @@ SHAT_SA
 
 **Definition**
 
-Magnetic shear :math:`{\frac {r}{q}}{\frac {\partial q}{\partial r}}`.
+Magnetic shear :math:`{\frac {r}{q}}{\frac {\partial q}{\partial r}}`. Caution: Only used for :math:`s-\alpha` geometry (GEOMETRY_FLAG = 0), otherwise see Q_PRIME_LOC.
 
 
 **Comments**