Skip to content

Commit 8ba1dbb

Browse files
committed
deploy: 4d50830
1 parent 021a5dd commit 8ba1dbb

File tree

5 files changed

+84
-2
lines changed

5 files changed

+84
-2
lines changed

.doctrees/6_inputdeck.doctree

-1.56 KB
Binary file not shown.

.doctrees/environment.pickle

0 Bytes
Binary file not shown.

6_inputdeck.html

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
<script src="_static/documentation_options.js?v=2709fde1"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
19+
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
1920
<script src="_static/js/theme.js"></script>
2021
<link rel="index" title="Index" href="genindex.html" />
2122
<link rel="search" title="Search" href="search.html" />
@@ -161,6 +162,87 @@ <h2>Input and Range Control<a class="headerlink" href="#input-and-range-control"
161162
</section>
162163
<section id="numerical-methods">
163164
<h2>Numerical Methods<a class="headerlink" href="#numerical-methods" title="Link to this heading"></a></h2>
165+
<table class="docutils align-default">
166+
<thead>
167+
<tr class="row-odd"><th class="head"><p>Key</p></th>
168+
<th class="head"><p>Description</p></th>
169+
<th class="head"><p>Value(s)</p></th>
170+
<th class="head"><p>Explaination</p></th>
171+
</tr>
172+
</thead>
173+
<tbody>
174+
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">if_backward</span></code></p></td>
175+
<td><p>Backward integration flag</p></td>
176+
<td><p><code class="docutils literal notranslate"><span class="pre">0</span></code></p></td>
177+
<td><p>Only compute forward advection.</p></td>
178+
</tr>
179+
<tr class="row-odd"><td></td>
180+
<td></td>
181+
<td><p>(<code class="docutils literal notranslate"><span class="pre">1</span></code>)</p></td>
182+
<td><p>Compute in both side.</p></td>
183+
</tr>
184+
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">wall_treatment</span></code></p></td>
185+
<td><p>Wall-treatment strategy</p></td>
186+
<td><p>(<code class="docutils literal notranslate"><span class="pre">clamp</span></code>)</p></td>
187+
<td></td>
188+
</tr>
189+
<tr class="row-odd"><td></td>
190+
<td></td>
191+
<td><p><code class="docutils literal notranslate"><span class="pre">dirichlet</span></code></p></td>
192+
<td></td>
193+
</tr>
194+
<tr class="row-even"><td></td>
195+
<td></td>
196+
<td><p><code class="docutils literal notranslate"><span class="pre">reflect`</span></code></p></td>
197+
<td></td>
198+
</tr>
199+
<tr class="row-odd"><td></td>
200+
<td></td>
201+
<td><p><code class="docutils literal notranslate"><span class="pre">periodic`</span></code></p></td>
202+
<td></td>
203+
</tr>
204+
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">advc_method</span></code></p></td>
205+
<td><p>Lagrangian advection scheme</p></td>
206+
<td><p>(<code class="docutils literal notranslate"><span class="pre">Euler</span></code>)</p></td>
207+
<td><p>Simple and fast Euler stepping with</p></td>
208+
</tr>
209+
<tr class="row-odd"><td></td>
210+
<td></td>
211+
<td><p><code class="docutils literal notranslate"><span class="pre">RK2</span></code></p></td>
212+
<td><p>Runge–Kutta 2 with <span class="math notranslate nohighlight">\(\max_{0 \le n \le N} \lvert y(t_n) - y_n \rvert = O(h^1)\)</span></p></td>
213+
</tr>
214+
<tr class="row-even"><td></td>
215+
<td></td>
216+
<td><p><code class="docutils literal notranslate"><span class="pre">RK4`</span></code></p></td>
217+
<td></td>
218+
</tr>
219+
<tr class="row-odd"><td></td>
220+
<td></td>
221+
<td><p><code class="docutils literal notranslate"><span class="pre">RK6`</span></code></p></td>
222+
<td></td>
223+
</tr>
224+
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">interp_method</span></code></p></td>
225+
<td><p>Interpolation method</p></td>
226+
<td><p><code class="docutils literal notranslate"><span class="pre">&lt;string&gt;</span></code></p></td>
227+
<td><p>NA</p></td>
228+
</tr>
229+
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">grad_order</span></code></p></td>
230+
<td><p>Gradient approximation scheme</p></td>
231+
<td><p><code class="docutils literal notranslate"><span class="pre">&lt;int&gt;</span></code></p></td>
232+
<td><p>NA</p></td>
233+
</tr>
234+
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">Eigen_method</span></code></p></td>
235+
<td><p>Eigenvalue computation method</p></td>
236+
<td><p><code class="docutils literal notranslate"><span class="pre">&lt;string&gt;</span></code></p></td>
237+
<td><p>NA</p></td>
238+
</tr>
239+
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">if_visual</span></code></p></td>
240+
<td><p>Glace visualization enabler</p></td>
241+
<td><p><code class="docutils literal notranslate"><span class="pre">0</span></code> or <code class="docutils literal notranslate"><span class="pre">1</span></code></p></td>
242+
<td><p>Take a pop-up glance on the results after computation for check with a rudimentary appearance.</p></td>
243+
</tr>
244+
</tbody>
245+
</table>
164246
</section>
165247
<section id="dynamic-lcs-window">
166248
<h2>Dynamic LCS Window<a class="headerlink" href="#dynamic-lcs-window" title="Link to this heading"></a></h2>

_sources/6_inputdeck.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Numerical Methods
5050
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
5151
| | | ``periodic``` | |
5252
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
53-
| ``advc_method`` | Lagrangian advection scheme | (``Euler``) | Simple and fast Euler stepping with |
53+
| ``advc_method`` | Lagrangian advection scheme | (``Euler``) | Simple and fast Euler stepping with |
5454
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
5555
| | | ``RK2`` | Runge–Kutta 2 with :math:`\max_{0 \le n \le N} \lvert y(t_n) - y_n \rvert = O(h^1)` |
5656
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)