Skip to content

Commit e292794

Browse files
committed
deploy: 886b593
1 parent c721bb1 commit e292794

5 files changed

Lines changed: 59 additions & 58 deletions

File tree

.doctrees/6_inputdeck.doctree

-227 Bytes
Binary file not shown.

.doctrees/environment.pickle

0 Bytes
Binary file not shown.

6_inputdeck.html

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -91,17 +91,17 @@
9191
</thead>
9292
<tbody>
9393
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">vtk_folder</span></code></p></td>
94-
<td><p>Path to folder containing VTK data files</p></td>
95-
<td><p><code class="docutils literal notranslate"><span class="pre">&lt;path&gt;</span></code></p></td>
94+
<td><p>Path to folder containing VTK input data</p></td>
95+
<td><p><code class="docutils literal notranslate"><span class="pre">&lt;string&gt;</span></code></p></td>
9696
<td><p>NA</p></td>
9797
</tr>
9898
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">output_dir</span></code></p></td>
99-
<td><p>Path to directory for saving FTLE results</p></td>
100-
<td><p><code class="docutils literal notranslate"><span class="pre">&lt;path&gt;</span></code></p></td>
99+
<td><p>Path to directory for saving results</p></td>
100+
<td><p><code class="docutils literal notranslate"><span class="pre">&lt;string&gt;</span></code></p></td>
101101
<td><p>NA</p></td>
102102
</tr>
103103
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">auto_wall</span></code></p></td>
104-
<td><p>Flag for automatic wall detection (0 = off, 1 = on)</p></td>
104+
<td><p>Flag for automatic wall detection</p></td>
105105
<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>
106106
<td><p>NA</p></td>
107107
</tr>
@@ -136,17 +136,17 @@
136136
<td><p>NA</p></td>
137137
</tr>
138138
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">T_range</span></code></p></td>
139-
<td><p>Integration time range [Tstart, Tend]</p></td>
139+
<td><p>Time range [Tstart, Tend] in frames</p></td>
140140
<td><p><code class="docutils literal notranslate"><span class="pre">[&lt;float&gt;,</span> <span class="pre">&lt;float&gt;]</span></code></p></td>
141141
<td><p>NA</p></td>
142142
</tr>
143143
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">dt</span></code></p></td>
144-
<td><p>Time step for particle advection</p></td>
144+
<td><p>Time step (frame) for particle advection</p></td>
145145
<td><p><code class="docutils literal notranslate"><span class="pre">&lt;float&gt;</span></code></p></td>
146146
<td><p>NA</p></td>
147147
</tr>
148148
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">if_backward</span></code></p></td>
149-
<td><p>Backward integration flag (0 = off, 1 = on)</p></td>
149+
<td><p>Backward integration flag</p></td>
150150
<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>
151151
<td><p>NA</p></td>
152152
</tr>
@@ -160,12 +160,13 @@
160160
<td><p><code class="docutils literal notranslate"><span class="pre">&lt;string&gt;</span></code></p></td>
161161
<td><p>NA</p></td>
162162
</tr>
163-
<tr class="row-even"><td colspan="2"><p><a href="#id1"><span class="problematic" id="id2">``</span></a>wall_treatment``| Wall-treatment strategy</p></td>
163+
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">wall_treatment</span></code></p></td>
164+
<td><p>Wall-treatment strategy</p></td>
164165
<td><p><code class="docutils literal notranslate"><span class="pre">&lt;string&gt;</span></code></p></td>
165166
<td><p>NA</p></td>
166167
</tr>
167168
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">grad_order</span></code></p></td>
168-
<td><p>Order of spatial gradient approximation</p></td>
169+
<td><p>Gradient approximation scheme</p></td>
169170
<td><p><code class="docutils literal notranslate"><span class="pre">&lt;int&gt;</span></code></p></td>
170171
<td><p>NA</p></td>
171172
</tr>
@@ -175,13 +176,13 @@
175176
<td><p>NA</p></td>
176177
</tr>
177178
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">if_visual</span></code></p></td>
178-
<td><p>Visualization flag (0 = off; 1 = on)</p></td>
179+
<td><p>Glace visualization enabler</p></td>
179180
<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>
180181
<td><p>NA</p></td>
181182
</tr>
182183
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">dyn_mode</span></code></p></td>
183184
<td><p>Dynamic LCS mode selector</p></td>
184-
<td><p><code class="docutils literal notranslate"><span class="pre">&lt;int&gt;</span></code></p></td>
185+
<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>
185186
<td><p>NA</p></td>
186187
</tr>
187188
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">win_size</span></code></p></td>

_sources/6_inputdeck.rst.txt

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -5,51 +5,51 @@ Input Deck for Solver Parameters
55

66
To become
77

8-
+------------------+-----------------------------------------------------------+-------------------------+---------+
9-
| Key | Description | Value(s) | Methods |
10-
+==================+===========================================================+=========================+=========+
11-
| ``vtk_folder`` | Path to folder containing VTK data files | ``<path>`` | NA |
12-
+------------------+-----------------------------------------------------------+-------------------------+---------+
13-
| ``output_dir`` | Path to directory for saving FTLE results | ``<path>`` | NA |
14-
+------------------+-----------------------------------------------------------+-------------------------+---------+
15-
| ``auto_wall`` | Flag for automatic wall detection (0 = off, 1 = on) | ``0`` or ``1`` | NA |
16-
+------------------+-----------------------------------------------------------+-------------------------+---------+
17-
| ``wall_xrange`` | X-direction wall bounds [xmin, xmax] | ``[<float>, <float>]`` | NA |
18-
+------------------+-----------------------------------------------------------+-------------------------+---------+
19-
| ``wall_yrange`` | Y-direction wall bounds [ymin, ymax] | ``[<float>, <float>]`` | NA |
20-
+------------------+-----------------------------------------------------------+-------------------------+---------+
21-
| ``wall_zrange`` | Z-direction wall bounds [zmin, zmax] | ``[<float>, <float>]`` | NA |
22-
+------------------+-----------------------------------------------------------+-------------------------+---------+
23-
| ``x`` | Number of seed points in X direction | ``<int>`` | NA |
24-
+------------------+-----------------------------------------------------------+-------------------------+---------+
25-
| ``y`` | Number of seed points in Y direction | ``<int>`` | NA |
26-
+------------------+-----------------------------------------------------------+-------------------------+---------+
27-
| ``z`` | Number of seed points in Z direction | ``<int>`` | NA |
28-
+------------------+-----------------------------------------------------------+-------------------------+---------+
29-
| ``T_range`` | Integration time range [Tstart, Tend] | ``[<float>, <float>]`` | NA |
30-
+------------------+-----------------------------------------------------------+-------------------------+---------+
31-
| ``dt`` | Time step for particle advection | ``<float>`` | NA |
32-
+------------------+-----------------------------------------------------------+-------------------------+---------+
33-
| ``if_backward`` | Backward integration flag (0 = off, 1 = on) | ``0`` or ``1`` | NA |
34-
+------------------+-----------------------------------------------------------+-------------------------+---------+
35-
| ``advc_method`` | Advection scheme | ``<string>`` | NA |
36-
+------------------+-----------------------------------------------------------+-------------------------+---------+
37-
| ``interp_method``| Interpolation method | ``<string>`` | NA |
38-
+------------------+-----------------------------------------------------------+-------------------------+---------+
39-
| ``wall_treatment``| Wall-treatment strategy | ``<string>`` | NA |
40-
+------------------+-----------------------------------------------------------+-------------------------+---------+
41-
| ``grad_order`` | Order of spatial gradient approximation | ``<int>`` | NA |
42-
+------------------+-----------------------------------------------------------+-------------------------+---------+
43-
| ``Eigen_method`` | Eigenvalue computation method | ``<string>`` | NA |
44-
+------------------+-----------------------------------------------------------+-------------------------+---------+
45-
| ``if_visual`` | Visualization flag (0 = off; 1 = on) | ``0`` or ``1`` | NA |
46-
+------------------+-----------------------------------------------------------+-------------------------+---------+
47-
| ``dyn_mode`` | Dynamic LCS mode selector | ``<int>`` | NA |
48-
+------------------+-----------------------------------------------------------+-------------------------+---------+
49-
| ``win_size`` | Window size for dynamic LCS | ``<int>`` or None | NA |
50-
+------------------+-----------------------------------------------------------+-------------------------+---------+
51-
| ``win_step`` | Window step for dynamic LCS | ``<int>`` or None | NA |
52-
+------------------+-----------------------------------------------------------+-------------------------+---------+
8+
+-------------------+------------------------------------------------------+-------------------------+---------+
9+
| Key | Description | Value(s) | Methods |
10+
+===================+======================================================+=========================+=========+
11+
| ``vtk_folder`` | Path to folder containing VTK input data | ``<string>`` | NA |
12+
+-------------------+------------------------------------------------------+-------------------------+---------+
13+
| ``output_dir`` | Path to directory for saving results | ``<string>`` | NA |
14+
+-------------------+------------------------------------------------------+-------------------------+---------+
15+
| ``auto_wall`` | Flag for automatic wall detection | ``0`` or ``1`` | NA |
16+
+-------------------+------------------------------------------------------+-------------------------+---------+
17+
| ``wall_xrange`` | X-direction wall bounds [xmin, xmax] | ``[<float>, <float>]`` | NA |
18+
+-------------------+------------------------------------------------------+-------------------------+---------+
19+
| ``wall_yrange`` | Y-direction wall bounds [ymin, ymax] | ``[<float>, <float>]`` | NA |
20+
+-------------------+------------------------------------------------------+-------------------------+---------+
21+
| ``wall_zrange`` | Z-direction wall bounds [zmin, zmax] | ``[<float>, <float>]`` | NA |
22+
+-------------------+------------------------------------------------------+-------------------------+---------+
23+
| ``x`` | Number of seed points in X direction | ``<int>`` | NA |
24+
+-------------------+------------------------------------------------------+-------------------------+---------+
25+
| ``y`` | Number of seed points in Y direction | ``<int>`` | NA |
26+
+-------------------+------------------------------------------------------+-------------------------+---------+
27+
| ``z`` | Number of seed points in Z direction | ``<int>`` | NA |
28+
+-------------------+------------------------------------------------------+-------------------------+---------+
29+
| ``T_range`` | Time range [Tstart, Tend] in frames | ``[<float>, <float>]`` | NA |
30+
+-------------------+------------------------------------------------------+-------------------------+---------+
31+
| ``dt`` | Time step (frame) for particle advection | ``<float>`` | NA |
32+
+-------------------+------------------------------------------------------+-------------------------+---------+
33+
| ``if_backward`` | Backward integration flag | ``0`` or ``1`` | NA |
34+
+-------------------+------------------------------------------------------+-------------------------+---------+
35+
| ``advc_method`` | Advection scheme | ``<string>`` | NA |
36+
+-------------------+------------------------------------------------------+-------------------------+---------+
37+
| ``interp_method`` | Interpolation method | ``<string>`` | NA |
38+
+-------------------+------------------------------------------------------+-------------------------+---------+
39+
| ``wall_treatment``| Wall-treatment strategy | ``<string>`` | NA |
40+
+-------------------+------------------------------------------------------+-------------------------+---------+
41+
| ``grad_order`` | Gradient approximation scheme | ``<int>`` | NA |
42+
+-------------------+------------------------------------------------------+-------------------------+---------+
43+
| ``Eigen_method`` | Eigenvalue computation method | ``<string>`` | NA |
44+
+-------------------+------------------------------------------------------+-------------------------+---------+
45+
| ``if_visual`` | Glace visualization enabler | ``0`` or ``1`` | NA |
46+
+-------------------+------------------------------------------------------+-------------------------+---------+
47+
| ``dyn_mode`` | Dynamic LCS mode selector | ``0`` or ``1`` | NA |
48+
+-------------------+------------------------------------------------------+-------------------------+---------+
49+
| ``win_size`` | Window size for dynamic LCS | ``<int>`` or None | NA |
50+
+-------------------+------------------------------------------------------+-------------------------+---------+
51+
| ``win_step`` | Window step for dynamic LCS | ``<int>`` or None | NA |
52+
+-------------------+------------------------------------------------------+-------------------------+---------+
5353

5454

5555
.. _flow_vars:

0 commit comments

Comments
 (0)