Skip to content

Commit

Permalink
Add optimization related tab
Browse files Browse the repository at this point in the history
  • Loading branch information
sfiligoi committed Jul 18, 2024
1 parent f84a044 commit 2a51684
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 12 deletions.
43 changes: 34 additions & 9 deletions docs/cgyro/cgyro_table.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ <h1>Tabular list for input.cgyro<a class="headerlink" href="#tabular-list-for-in
<li><p><a class="reference internal" href="#tab-rotation"><span class="std std-ref">Rotation physics</span></a></p></li>
<li><p><a class="reference internal" href="#tab-global"><span class="std std-ref">Global-spectral parameters</span></a></p></li>
<li><p><a class="reference internal" href="#tab-output"><span class="std std-ref">Output file control</span></a></p></li>
<li><p><a class="reference internal" href="#tab-optimization"><span class="std std-ref">Optimization related parameters</span></a></p></li>
</ul>
<span id="tab-shape"></span><table class="docutils align-default" id="id1">
<caption><span class="caption-text"><strong>Plasma shape/geometry</strong></span><a class="headerlink" href="#id1" title="Link to this table"></a></caption>
Expand Down Expand Up @@ -421,11 +422,7 @@ <h1>Tabular list for input.cgyro<a class="headerlink" href="#tabular-list-for-in
<td><p>Binormal spectral upwind order</p></td>
<td><p>3</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="cgyro_list.html#cgyro-velocity-order"><span class="std std-ref">VELOCITY_ORDER</span></a></p></td>
<td><p>What internal velocity order to use</p></td>
<td><p>1</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="cgyro_list.html#cgyro-upwind-single-flag"><span class="std std-ref">UPWIND_SINGLE_FLAG</span></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="cgyro_list.html#cgyro-upwind-single-flag"><span class="std std-ref">UPWIND_SINGLE_FLAG</span></a></p></td>
<td><p>Use reduced precision communication</p></td>
<td><p>0</p></td>
</tr>
Expand Down Expand Up @@ -565,10 +562,6 @@ <h1>Tabular list for input.cgyro<a class="headerlink" href="#tabular-list-for-in
<td><p>Reduce Sugama memory use</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="cgyro_list.html#cgyro-gpu-bigmem-flag"><span class="std std-ref">GPU_BIGMEM_FLAG</span></a></p></td>
<td><p>Enable GPU offload</p></td>
<td><p>1</p></td>
</tr>
</tbody>
</table>
<span id="tab-rotation"></span><table class="docutils align-default" id="id10">
Expand Down Expand Up @@ -671,6 +664,38 @@ <h1>Tabular list for input.cgyro<a class="headerlink" href="#tabular-list-for-in
</tr>
</tbody>
</table>
<span id="tab-optimization"></span><table class="docutils align-default" id="id13">
<caption><span class="caption-text"><strong>Optimization related parameters</strong></span><a class="headerlink" href="#id13" title="Link to this table"></a></caption>
<colgroup>
<col style="width: 30.2%" />
<col style="width: 58.1%" />
<col style="width: 11.6%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>input.cgyro parameter</p></th>
<th class="head"><p>Short description</p></th>
<th class="head"><p>Default</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference internal" href="cgyro_list.html#cgyro-toroidals-per-proc"><span class="std std-ref">TOROIDALS_PER_PROC</span></a></p></td>
<td><p>How many toroidal harmonics per MPI process</p></td>
<td><p>1</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="cgyro_list.html#cgyro-mpi-rank-order"><span class="std std-ref">MPI_RANK_ORDER</span></a></p></td>
<td><p>Relative ordering of MPI ranks</p></td>
<td><p>2</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="cgyro_list.html#cgyro-velocity-order"><span class="std std-ref">VELOCITY_ORDER</span></a></p></td>
<td><p>What internal velocity order to use</p></td>
<td><p>1</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="cgyro_list.html#cgyro-gpu-bigmem-flag"><span class="std std-ref">GPU_BIGMEM_FLAG</span></a></p></td>
<td><p>Enable GPU offload when possible</p></td>
<td><p>1</p></td>
</tr>
</tbody>
</table>
</section>


Expand Down
Binary file modified docs/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

15 changes: 13 additions & 2 deletions html/src/cgyro/cgyro_table.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Tabular list for input.cgyro
* :ref:`tab-rotation`
* :ref:`tab-global`
* :ref:`tab-output`
* :ref:`tab-optimization`

.. _tab-shape:

Expand Down Expand Up @@ -109,7 +110,6 @@ Tabular list for input.cgyro
":ref:`cgyro_nup_radial`", Radial spectral upwind order,3
":ref:`cgyro_nup_theta`", Poloidal upwind order,3
":ref:`cgyro_nup_alpha`", Binormal spectral upwind order,3
":ref:`cgyro_velocity_order`", What internal velocity order to use,1
":ref:`cgyro_upwind_single_flag`", Use reduced precision communication,0

.. _tab-time:
Expand Down Expand Up @@ -154,7 +154,6 @@ Tabular list for input.cgyro
":ref:`cgyro_collision_ene_diffusion`", Toggle energy diffusion,1
":ref:`cgyro_collision_kperp`", Toggle so-called FLR term, 0
":ref:`cgyro_collision_precision_mode`", Reduce Sugama memory use, 0
":ref:`cgyro_gpu_bigmem_flag`", Enable GPU offload, 1

.. _tab-rotation:

Expand Down Expand Up @@ -189,3 +188,15 @@ Tabular list for input.cgyro
":ref:`cgyro_moment_print_flag`", Output of density and energy moments, 0
":ref:`cgyro_gflux_print_flag`", Output of global flux profiles, 0
":ref:`cgyro_h_print_flag`", Output of distribution (single-mode only), 0

.. _tab-optimization:

.. csv-table:: **Optimization related parameters**
:header: "input.cgyro parameter", "Short description", "Default"
:widths: 13, 25, 5

":ref:`cgyro_toroidals_per_proc`", How many toroidal harmonics per MPI process,1
":ref:`cgyro_mpi_rank_order`", Relative ordering of MPI ranks,2
":ref:`cgyro_velocity_order`", What internal velocity order to use,1
":ref:`cgyro_gpu_bigmem_flag`", Enable GPU offload when possible, 1

0 comments on commit 2a51684

Please sign in to comment.