Skip to content

Commit f5c1ae7

Browse files
hweifluidshweifluids
committed
Update 6_inputdeck.rst
1 parent 886b593 commit f5c1ae7

1 file changed

Lines changed: 62 additions & 46 deletions

File tree

‎source/6_inputdeck.rst‎

Lines changed: 62 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -3,53 +3,69 @@
33
Input Deck for Solver Parameters
44
================================
55

6-
To become
6+
Input and Range Control
7+
---------------------------------
8+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
9+
| Key | Description | Value(s) | Explaination and Notes |
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`` | Manually indicate computation bounds |
16+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
17+
| | | (``1``) | Auto detect bounds from input mesh |
18+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
19+
| ``wall_xrange`` | X-direction wall bounds [xmin, xmax] | ``[<float>, <float>]`` | |
20+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
21+
| ``wall_yrange`` | Y-direction wall bounds [ymin, ymax] | ``[<float>, <float>]`` | |
22+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
23+
| ``wall_zrange`` | Z-direction wall bounds [zmin, zmax] | ``[<float>, <float>]`` | |
24+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
25+
| ``x`` | Number of seed points in X direction | ``<int>`` | |
26+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
27+
| ``y`` | Number of seed points in Y direction | ``<int>`` | |
28+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
29+
| ``z`` | Number of seed points in Z direction | ``<int>`` | |
30+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
31+
| ``T_range`` | Time range [``T_start``, ``T_end``] in frames | ``[<float>, <float>]`` | ``T_end`` no larger than ``N_frames`` |
32+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
33+
| ``dt`` | Time step for particle advection in frames | ``<float>`` | NA |
34+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
735

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-
+-------------------+------------------------------------------------------+-------------------------+---------+
36+
Numerical Methods
37+
---------------------------------
38+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
39+
| Key | Description | Value(s) | Explaination and Notes |
40+
+===================+======================================================+=========================+=========================================+
41+
| ``if_backward`` | Backward integration flag | ``0`` | Only compute forward advection |
42+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
43+
| | | (``1``) | Compute in both side |
44+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
45+
| ``advc_method`` | Advection scheme | ``<string>`` | NA |
46+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
47+
| ``interp_method`` | Interpolation method | ``<string>`` | NA |
48+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
49+
| ``wall_treatment``| Wall-treatment strategy | ``clamp`` | NA |
50+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
51+
| ``grad_order`` | Gradient approximation scheme | ``<int>`` | NA |
52+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
53+
| ``Eigen_method`` | Eigenvalue computation method | ``<string>`` | NA |
54+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
55+
| ``if_visual`` | Glace visualization enabler | ``0`` or ``1`` | NA |
56+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
57+
58+
Dynamic LCS Window
59+
---------------------------------
60+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
61+
| Key | Description | Value(s) | Explaination and Notes |
62+
+===================+======================================================+=========================+=========================================+
63+
| ``dyn_mode`` | Dynamic LCS mode selector | ``0`` or ``1`` | NA |
64+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
65+
| ``win_size`` | Window size for dynamic LCS | ``<float>`` | NA |
66+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
67+
| ``win_step`` | Window step for dynamic LCS | ``<float>`` | NA |
68+
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
5369

5470

5571
.. _flow_vars:

0 commit comments

Comments
 (0)