Fixed rotation typos in manual and website

gafusion · Sep 4, 2024 · 8cbdd69 · 8cbdd69
1 parent 0ae529c
commit 8cbdd69
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 21 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 711f83b3aa3bbab10fa381c061ae4e28
+config: 556eb8091613b199f169c4c376f2cb96
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/genindex.html b/docs/genindex.html
@@ -6,7 +6,7 @@
   <title>Index &mdash; GACODE</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
-      <link rel="stylesheet" type="text/css" href="_static/contentui.css" />
+      <link rel="stylesheet" type="text/css" href="_static/contentui.css?v=4cf5b151" />
 
 
     <link rel="shortcut icon" href="_static/favicon.ico"/>
@@ -19,7 +19,7 @@
         <script src="_static/documentation_options.js?v=5929fcd5"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
-        <script src="_static/contentui.js"></script>
+        <script src="_static/contentui.js?v=9ee86694"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="#" />
     <link rel="search" title="Search" href="search.html" /> 

diff --git a/docs/index.html b/docs/index.html
@@ -7,7 +7,7 @@
   <title>The General Atomics GACODE Suite &mdash; GACODE</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
-      <link rel="stylesheet" type="text/css" href="_static/contentui.css" />
+      <link rel="stylesheet" type="text/css" href="_static/contentui.css?v=4cf5b151" />
 
 
     <link rel="shortcut icon" href="_static/favicon.ico"/>
@@ -20,7 +20,7 @@
         <script src="_static/documentation_options.js?v=5929fcd5"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
-        <script src="_static/contentui.js"></script>
+        <script src="_static/contentui.js?v=9ee86694"></script>
         <script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />

diff --git a/docs/rotation.html b/docs/rotation.html
@@ -7,7 +7,7 @@
   <title>PLASMA ROTATION THEORY &mdash; GACODE</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
-      <link rel="stylesheet" type="text/css" href="_static/contentui.css" />
+      <link rel="stylesheet" type="text/css" href="_static/contentui.css?v=4cf5b151" />
 
 
     <link rel="shortcut icon" href="_static/favicon.ico"/>
@@ -20,7 +20,7 @@
         <script src="_static/documentation_options.js?v=5929fcd5"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
-        <script src="_static/contentui.js"></script>
+        <script src="_static/contentui.js?v=9ee86694"></script>
         <script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
@@ -147,15 +147,15 @@ <h2>Input parameters<a class="headerlink" href="#input-parameters" title="Link t
 </thead>
 <tbody>
 <tr class="row-even"><td><p><a class="reference internal" href="cgyro/cgyro_list.html#cgyro-gamma-e"><span class="std std-ref">GAMMA_E</span></a></p></td>
-<td><p><span class="math notranslate nohighlight">\(\displaystyle \frac{a}{c_s} \, \gamma_{\rm E} \doteq -\frac{r}{q}\frac{d \omega_{0}}{d r}\)</span></p></td>
+<td><p><span class="math notranslate nohighlight">\(\displaystyle \frac{a}{c_s} \, \gamma_{\rm E}\;\)</span> where <span class="math notranslate nohighlight">\(\; \displaystyle \gamma_{\rm E} \doteq -\frac{r}{q}\frac{d \omega_{0}}{d r}\)</span></p></td>
 <td><p><span class="math notranslate nohighlight">\(\mathbf{E}\times\mathbf{B}\)</span> shearing rate</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="cgyro/cgyro_list.html#cgyro-gamma-p"><span class="std std-ref">GAMMA_P</span></a></p></td>
-<td><p><span class="math notranslate nohighlight">\(\displaystyle \frac{a}{c_s} \, \gamma_p \doteq -R_0\frac{d \omega_{0}}{d r}\)</span></p></td>
+<td><p><span class="math notranslate nohighlight">\(\displaystyle \frac{a}{c_s} \, \gamma_p\;\)</span> where <span class="math notranslate nohighlight">\(\; \displaystyle \gamma_{\rm p} \doteq -R_0\frac{d \omega_{0}}{d r}\)</span></p></td>
 <td><p>rotation shearing rate</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="cgyro/cgyro_list.html#cgyro-mach"><span class="std std-ref">MACH</span></a></p></td>
-<td><p><span class="math notranslate nohighlight">\(\displaystyle M \doteq \frac{\omega_0 R_0}{c_s}\)</span></p></td>
+<td><p><span class="math notranslate nohighlight">\(\displaystyle M\;\)</span> where <span class="math notranslate nohighlight">\(\;\displaystyle M \doteq \frac{\omega_0 R_0}{c_s}\)</span></p></td>
 <td><p>rotation rate</p></td>
 </tr>
 </tbody>
@@ -174,11 +174,11 @@ <h2>Input parameters<a class="headerlink" href="#input-parameters" title="Link t
 </thead>
 <tbody>
 <tr class="row-even"><td><p><a class="reference internal" href="neo/neo_list.html#neo-omega-rot"><span class="std std-ref">OMEGA_ROT</span></a></p></td>
-<td><p><span class="math notranslate nohighlight">\(\displaystyle  \frac{a}{v_{norm}} \omega_0\)</span></p></td>
+<td><p><span class="math notranslate nohighlight">\(\displaystyle  \frac{a}{v_{\rm norm}} \omega_0\)</span></p></td>
 <td><p>rotation rate</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="neo/neo_list.html#neo-omega-rot-deriv"><span class="std std-ref">OMEGA_ROT_DERIV</span></a></p></td>
-<td><p><span class="math notranslate nohighlight">\(\displaystyle \frac{a^{2}}{v_{norm}} \frac{d \omega_{0}}{dr}\)</span></p></td>
+<td><p><span class="math notranslate nohighlight">\(\displaystyle \frac{a^{2}}{v_{\rm norm}} \frac{d \omega_{0}}{dr}\)</span></p></td>
 <td><p>derivative of rotation rate</p></td>
 </tr>
 </tbody>

diff --git a/docs/search.html b/docs/search.html
@@ -6,7 +6,7 @@
   <title>Search &mdash; GACODE</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
-      <link rel="stylesheet" type="text/css" href="_static/contentui.css" />
+      <link rel="stylesheet" type="text/css" href="_static/contentui.css?v=4cf5b151" />
 
 
     <link rel="shortcut icon" href="_static/favicon.ico"/>
@@ -20,7 +20,7 @@
         <script src="_static/documentation_options.js?v=5929fcd5"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
-        <script src="_static/contentui.js"></script>
+        <script src="_static/contentui.js?v=9ee86694"></script>
     <script src="_static/js/theme.js"></script>
     <script src="_static/searchtools.js"></script>
     <script src="_static/language_data.js"></script>

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/html/src/rotation.rst b/html/src/rotation.rst
@@ -41,16 +41,16 @@ CGYRO and NEO implement *full sonic rotation* (GYRO implements only a reduced mo
    :header: "input.cgyro parameter", "Definition", "Description"
    :widths: 10, 15, 15
 
-   ":ref:`cgyro_gamma_e`",":math:`\displaystyle \frac{a}{c_s} \, \gamma_{\rm E} \doteq -\frac{r}{q}\frac{d \omega_{0}}{d r}`",":math:`\exb` shearing rate" 
-   ":ref:`cgyro_gamma_p`",":math:`\displaystyle \frac{a}{c_s} \, \gamma_p \doteq -R_0\frac{d \omega_{0}}{d r}`","rotation shearing rate" 
-   ":ref:`cgyro_mach`",":math:`\displaystyle M \doteq \frac{\omega_0 R_0}{c_s}`","rotation rate" 
+   ":ref:`cgyro_gamma_e`",":math:`\displaystyle \frac{a}{c_s} \, \gamma_{\rm E}\;` where :math:`\; \displaystyle \gamma_{\rm E} \doteq -\frac{r}{q}\frac{d \omega_{0}}{d r}`",":math:`\exb` shearing rate" 
+   ":ref:`cgyro_gamma_p`",":math:`\displaystyle \frac{a}{c_s} \, \gamma_p\;` where :math:`\; \displaystyle \gamma_{\rm p} \doteq -R_0\frac{d \omega_{0}}{d r}`","rotation shearing rate" 
+   ":ref:`cgyro_mach`",":math:`\displaystyle M\;` where :math:`\;\displaystyle M \doteq \frac{\omega_0 R_0}{c_s}`","rotation rate" 
 
 .. csv-table::
    :header: "input.neo parameter", "Definition", "Description"
    :widths: 10, 15, 15
 
-   ":ref:`neo_omega_rot`",":math:`\displaystyle  \frac{a}{v_{norm}} \omega_0`","rotation rate" 
-   ":ref:`neo_omega_rot_deriv`",":math:`\displaystyle \frac{a^{2}}{v_{norm}} \frac{d \omega_{0}}{dr}`","derivative of rotation rate" 
+   ":ref:`neo_omega_rot`",":math:`\displaystyle  \frac{a}{v_{\rm norm}} \omega_0`","rotation rate" 
+   ":ref:`neo_omega_rot_deriv`",":math:`\displaystyle \frac{a^{2}}{v_{\rm norm}} \frac{d \omega_{0}}{dr}`","derivative of rotation rate" 
 
 Theoretical basis for sonic rotation
 ------------------------------------

diff --git a/manuals/gyro/gkmodel.tex b/manuals/gyro/gkmodel.tex
@@ -357,7 +357,7 @@ \subsection{Rotation and rotation shear parameters}
 are not independent; rather, we have the constraint
 %
 \begin{equation}
-\gamma_p = \frac{R_0}{q r} \gamma_E \; .
+\gamma_p = \frac{q R_0}{r} \gamma_E \; .
 \end{equation}
 
 \subsection{Comment on the Hahm-Burrell shearing rate}

diff --git a/manuals/gyro/gyro_technical_manual.pdf b/manuals/gyro/gyro_technical_manual.pdf