Skip to content

Commit 438b14b

Browse files
committed
table
1 parent f5c1ae7 commit 438b14b

2 files changed

Lines changed: 66 additions & 56 deletions

File tree

source/2_theory.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,12 @@
33
Theory of FTLE and LCS
44
======================
55

6-
This page introduces the theory of Finite-Time Lyapunov Exponents (FTLE) and Lagrangian Coherent Structures (LCS). It covers the mathematical foundations and applications of these concepts in fluid dynamics and other fields.
6+
This page introduces the theory of Finite-Time Lyapunov Exponents (FTLE) and Lagrangian Coherent Structures (LCS). It covers the mathematical foundations and applications of these concepts in fluid dynamics and other fields.
7+
8+
.. _steady:
9+
Steady LCS
10+
--------------
11+
12+
.. _unsteady:
13+
Unsteady LCS
14+
--------------

source/6_inputdeck.rst

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

66
Input and Range Control
77
---------------------------------
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-
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
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+
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------+
3535

3636
Numerical Methods
3737
---------------------------------
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-
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
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+
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------+
5757

5858
Dynamic LCS Window
5959
---------------------------------
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-
+-------------------+------------------------------------------------------+-------------------------+-----------------------------------------+
60+
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------+
61+
| Key | Description | Value(s) | Explaination and Notes |
62+
+===================+======================================================+=========================+=========================================================+
63+
| ``dyn_mode`` | Dynamic LCS mode selector | (``0``) | Treat this input as a steady whole :ref:``steady``. |
64+
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------+
65+
| | | ``1`` | |
66+
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------+
67+
| ``win_size`` | Window size for dynamic LCS | ``<float>`` | NA |
68+
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------+
69+
| ``win_step`` | Window step for dynamic LCS | ``<float>`` | NA |
70+
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------+
6971

7072

7173
.. _flow_vars:

0 commit comments

Comments
 (0)