deploy: f98d2f1

Author: hweifluids

.doctrees/1_requirements.doctree

@@ -125,7 +125,7 @@ <h2>Add-on Libs<a class="headerlink" href="#add-on-libs" title="Link to this hea
 <section id="quickstart">
 <h2>Quickstart<a class="headerlink" href="#quickstart" title="Link to this heading"></a></h2>
 <p>An computation example coming with a set of our in-house downscaled Direct Navier-Stokes Simulation (DNS) data is provided, including :math:
-The dataset can be downloaded from <cite>here &lt;https://noting.noting&gt;__</cite>, and the case descriptions can be referred to paper <a href="#id2"><span class="problematic" id="id1">[1]_</span></a>.</p>
+The dataset can be downloaded from <a class="reference external" href="https://noting.noting">here</a>, and the case descriptions can be referred to paper <a href="#id2"><span class="problematic" id="id1">[1]_</span></a>.</p>
 </section>
 </section>
 

.doctrees/6_inputdeck.doctree

@@ -92,34 +92,34 @@ <h2>Input and Range Control<a class="headerlink" href="#input-and-range-control"
 <tr class="row-odd"><th class="head"><p>Key</p></th>
 <th class="head"><p>Description</p></th>
 <th class="head"><p>Value(s)</p></th>
-<th class="head"><p>Explaination and Notes</p></th>
+<th class="head"><p>Explaination</p></th>
 </tr>
 </thead>
 <tbody>
 <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">vtk_folder</span></code></p></td>
 <td><p>Path to folder containing VTK input data</p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">&lt;string&gt;</span></code></p></td>
-<td><p>NA</p></td>
+<td></td>
 </tr>
 <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">output_dir</span></code></p></td>
 <td><p>Path to directory for saving results</p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">&lt;string&gt;</span></code></p></td>
-<td><p>NA</p></td>
+<td></td>
 </tr>
 <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">auto_wall</span></code></p></td>
 <td><p>Flag for automatic wall detection</p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">0</span></code></p></td>
-<td><p>Manually indicate computation bounds</p></td>
+<td><p>Manually indicate computation bounds.</p></td>
 </tr>
 <tr class="row-odd"><td></td>
 <td></td>
 <td><p>(<code class="docutils literal notranslate"><span class="pre">1</span></code>)</p></td>
-<td><p>Auto detect bounds from input mesh</p></td>
+<td><p>Auto detect bounds from input mesh.</p></td>
 </tr>
 <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">wall_xrange</span></code></p></td>
 <td><p>X-direction wall bounds [xmin, xmax]</p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">[&lt;float&gt;,</span> <span class="pre">&lt;float&gt;]</span></code></p></td>
-<td></td>
+<td><p>Dimensionalized coordinates bounds.</p></td>
 </tr>
 <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">wall_yrange</span></code></p></td>
 <td><p>Y-direction wall bounds [ymin, ymax]</p></td>
@@ -132,86 +132,35 @@ <h2>Input and Range Control<a class="headerlink" href="#input-and-range-control"
 <td></td>
 </tr>
 <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">x</span></code></p></td>
-<td><p>Number of seed points in X direction</p></td>
+<td><p>Number of Lagrangian seed points in X direction</p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">&lt;int&gt;</span></code></p></td>
 <td></td>
 </tr>
 <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">y</span></code></p></td>
-<td><p>Number of seed points in Y direction</p></td>
+<td><p>Number of Lagrangian seed points in Y direction</p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">&lt;int&gt;</span></code></p></td>
 <td></td>
 </tr>
 <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">z</span></code></p></td>
-<td><p>Number of seed points in Z direction</p></td>
+<td><p>Number of Lagrangian seed points in Z direction</p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">&lt;int&gt;</span></code></p></td>
 <td></td>
 </tr>
 <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">T_range</span></code></p></td>
 <td><p>Time range [<code class="docutils literal notranslate"><span class="pre">T_start</span></code>, <code class="docutils literal notranslate"><span class="pre">T_end</span></code>] in frames</p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">[&lt;float&gt;,</span> <span class="pre">&lt;float&gt;]</span></code></p></td>
-<td><p><code class="docutils literal notranslate"><span class="pre">T_end</span></code> no larger than <code class="docutils literal notranslate"><span class="pre">N_frames</span></code></p></td>
+<td><p><code class="docutils literal notranslate"><span class="pre">T_end</span></code> no larger than <code class="docutils literal notranslate"><span class="pre">N_frames</span></code>.</p></td>
 </tr>
 <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">dt</span></code></p></td>
 <td><p>Time step for particle advection in frames</p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">&lt;float&gt;</span></code></p></td>
-<td><p>NA</p></td>
+<td></td>
 </tr>
 </tbody>
 </table>
 </section>
 <section id="numerical-methods">
 <h2>Numerical Methods<a class="headerlink" href="#numerical-methods" title="Link to this heading"></a></h2>
-<table class="docutils align-default">
-<thead>
-<tr class="row-odd"><th class="head"><p>Key</p></th>
-<th class="head"><p>Description</p></th>
-<th class="head"><p>Value(s)</p></th>
-<th class="head"><p>Explaination and Notes</p></th>
-</tr>
-</thead>
-<tbody>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">if_backward</span></code></p></td>
-<td><p>Backward integration flag</p></td>
-<td><p><code class="docutils literal notranslate"><span class="pre">0</span></code></p></td>
-<td><p>Only compute forward advection</p></td>
-</tr>
-<tr class="row-odd"><td></td>
-<td></td>
-<td><p>(<code class="docutils literal notranslate"><span class="pre">1</span></code>)</p></td>
-<td><p>Compute in both side</p></td>
-</tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">advc_method</span></code></p></td>
-<td><p>Advection scheme</p></td>
-<td><p><code class="docutils literal notranslate"><span class="pre">&lt;string&gt;</span></code></p></td>
-<td><p>NA</p></td>
-</tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">interp_method</span></code></p></td>
-<td><p>Interpolation method</p></td>
-<td><p><code class="docutils literal notranslate"><span class="pre">&lt;string&gt;</span></code></p></td>
-<td><p>NA</p></td>
-</tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">wall_treatment</span></code></p></td>
-<td><p>Wall-treatment strategy</p></td>
-<td><p><code class="docutils literal notranslate"><span class="pre">clamp</span></code></p></td>
-<td><p>NA</p></td>
-</tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">grad_order</span></code></p></td>
-<td><p>Gradient approximation scheme</p></td>
-<td><p><code class="docutils literal notranslate"><span class="pre">&lt;int&gt;</span></code></p></td>
-<td><p>NA</p></td>
-</tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">Eigen_method</span></code></p></td>
-<td><p>Eigenvalue computation method</p></td>
-<td><p><code class="docutils literal notranslate"><span class="pre">&lt;string&gt;</span></code></p></td>
-<td><p>NA</p></td>
-</tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">if_visual</span></code></p></td>
-<td><p>Glace visualization enabler</p></td>
-<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>
-<td><p>NA</p></td>
-</tr>
-</tbody>
-</table>
 </section>
 <section id="dynamic-lcs-window">
 <h2>Dynamic LCS Window<a class="headerlink" href="#dynamic-lcs-window" title="Link to this heading"></a></h2>
@@ -220,29 +169,29 @@ <h2>Dynamic LCS Window<a class="headerlink" href="#dynamic-lcs-window" title="Li
 <tr class="row-odd"><th class="head"><p>Key</p></th>
 <th class="head"><p>Description</p></th>
 <th class="head"><p>Value(s)</p></th>
-<th class="head"><p>Explaination and Notes</p></th>
+<th class="head"><p>Explaination</p></th>
 </tr>
 </thead>
 <tbody>
 <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">dyn_mode</span></code></p></td>
 <td><p>Dynamic LCS mode selector</p></td>
 <td><p>(<code class="docutils literal notranslate"><span class="pre">0</span></code>)</p></td>
-<td><p>Treat this input as a steady whole <a class="reference internal" href="2_theory.html#steady"><span class="std std-ref">Steady LCS</span></a>.</p></td>
+<td><p>Treat this input as a steady whole. See <a class="reference internal" href="2_theory.html#steady"><span class="std std-ref">Steady LCS</span></a>.</p></td>
 </tr>
 <tr class="row-odd"><td></td>
 <td></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">1</span></code></p></td>
-<td><p>Dynamic LCS computation <a class="reference internal" href="2_theory.html#unsteady"><span class="std std-ref">Unsteady LCS</span></a>.</p></td>
+<td><p>Dynamic LCS computation. See <a class="reference internal" href="2_theory.html#unsteady"><span class="std std-ref">Unsteady LCS</span></a>.</p></td>
 </tr>
 <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">win_size</span></code></p></td>
 <td><p>Window size for dynamic LCS</p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">&lt;float&gt;</span></code></p></td>
-<td><p>NA</p></td>
+<td><p>The window size in frames for each batch of computation. Available under <code class="docutils literal notranslate"><span class="pre">dyn_mode=1</span></code>.</p></td>
 </tr>
 <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">win_step</span></code></p></td>
 <td><p>Window step for dynamic LCS</p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">&lt;float&gt;</span></code></p></td>
-<td><p>NA</p></td>
+<td><p>Stepping in frames. Better smaller than <code class="docutils literal notranslate"><span class="pre">win_size/2</span></code> for capturing dynamic patterns.</p></td>
 </tr>
 </tbody>
 </table>

.doctrees/environment.pickle

@@ -53,4 +53,4 @@ Quickstart
 -----------------
 
 An computation example coming with a set of our in-house downscaled Direct Navier-Stokes Simulation (DNS) data is provided, including :math:
-The dataset can be downloaded from `here <https://noting.noting>__`, and the case descriptions can be referred to paper [1]_.
+The dataset can be downloaded from `here <https://noting.noting>`__, and the case descriptions can be referred to paper [1]_.