Skip to content

Commit c3d29cd

Browse files
committed
Update 6_inputdeck.rst
1 parent 3c9c1d9 commit c3d29cd

1 file changed

Lines changed: 46 additions & 25 deletions

File tree

source/6_inputdeck.rst

Lines changed: 46 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,52 @@ 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-
``output_dir`` Path to directory for saving FTLE results ``<path>`` NA
13-
``auto_wall`` Flag for automatic wall detection (0 = off, 1 = on) ``0`` or ``1`` NA
14-
``wall_xrange`` X-direction wall bounds [xmin, xmax] ``[<float>, <float>]`` NA
15-
``wall_yrange`` Y-direction wall bounds [ymin, ymax] ``[<float>, <float>]`` NA
16-
``wall_zrange`` Z-direction wall bounds [zmin, zmax] ``[<float>, <float>]`` NA
17-
``x`` Number of seed points in X direction ``<int>`` NA
18-
``y`` Number of seed points in Y direction ``<int>`` NA
19-
``z`` Number of seed points in Z direction ``<int>`` NA
20-
``T_range`` Integration time range [Tstart, Tend] ``[<float>, <float>]`` NA
21-
``dt`` Time step for particle advection ``<float>`` NA
22-
``if_backward`` Backward integration flag ``0`` or ``1`` NA
23-
``advc_method`` Advection scheme ``<string>`` NA
24-
``interp_method`` Interpolation method ``<string>`` NA
25-
``wall_treatment`` Wall-treatment strategy ``<string>`` NA
26-
``grad_order`` Order of spatial gradient approximation ``<int>`` NA
27-
``Eigen_method`` Eigenvalue computation method ``<string>`` NA
28-
``if_visual`` Visualization flag (0 = off; 1 = on) ``0`` or ``1`` NA
29-
``dyn_mode`` Dynamic LCS mode selector ``<int>`` NA
30-
``win_size`` Window size for dynamic LCS ``<int> or None`` NA
31-
``win_step`` Window step for dynamic LCS ``<int> or None`` NA
32-
========================= ======================================== ============================== ========
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+
+------------------+-----------------------------------------------------------+-------------------------+---------+
53+
3354

3455
.. _flow_vars:
3556

0 commit comments

Comments
 (0)