Skip to content

Commit 1c4b164

Browse files
committed
Update 6_inputdeck.rst
1 parent 72fa5b4 commit 1c4b164

1 file changed

Lines changed: 24 additions & 11 deletions

File tree

source/6_inputdeck.rst

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ Input and Range Control
3333
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
3434
| ``dt`` | Time step for particle advection in frames | ``<float>`` | |
3535
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
36+
| ``physical_dt`` | Physical time step between two input frames | ``<float>`` | |
37+
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
3638

3739
Numerical Methods
3840
---------------------------------
@@ -53,35 +55,38 @@ Numerical Methods
5355
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
5456
| | | ``periodic`` | |
5557
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
56-
| ``advc_method`` | Lagrangian advection scheme | (``Euler``) | Simple and fast Euler stepping with |
58+
| ``advc_method`` | Lagrangian advection scheme | (``Euler``) | Simple and fast Euler stepping with :math:`O(h^1)` error. |
5759
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
58-
| | | ``RK2`` | Runge–Kutta 2 with :math:`O(h^3)` error. |
60+
| | | ``RK2`` | Runge–Kutta 2 with :math:`O(h^2)` error. |
5961
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
6062
| | | ``RK4`` | Runge–Kutta 4 with :math:`O(h^4)` error. |
6163
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
6264
| | | ``RK6`` | Runge–Kutta 6 with :math:`O(h^6)` error. |
6365
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
64-
| ``interp_method`` | Interpolation method | ``trilinear`` | NA |
66+
| ``interp_method`` | Interpolation method for velocity fields | ``trilinear`` | Simple and fast triliear interpolation method. Very fast on GPUs. |
6567
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
66-
| | | ``tricubic`` | |
68+
| | | (``tricubic``) | |
6769
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
6870
| | | ``hermite`` | |
6971
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
70-
| | | ``reflect`` | |
72+
| | | ``WENO`` | Weighted Essentially Non-Oscillatory (WENO) scheme with shockwave capture capability. |
7173
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
72-
| ``grad_order`` | The method (order) of gradient discretization | ``2`` | 2nd-order central difference. |
74+
| ``grad_order`` | The method (order) of gradient discretization | (``2``) | 2nd-order central difference. |
7375
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
74-
| | | ``4`` | 4th-order central difference. |
76+
| | | ``4`` | ``I.P.`` 4th-order central difference. |
7577
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
76-
| | | ``6`` | 6th-order central difference. |
78+
| | | ``6`` | ``I.P.`` 6th-order central difference. |
7779
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
78-
| | | ``100`` | |
80+
| | | ``100`` | ``I.P.`` Global Fast Fourier Transform (FFT) with finite order. Compute extremely intensive! |
7981
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
80-
| ``Eigen_method`` | Eigenvalue computation method | ``<string>`` | NA |
82+
| ``Eigen_method`` | Solver for max eigenvalue of Cauchy–Green tensor | ``eigmax_sym3`` | Closed-form cubic eigenvalue solver for symmetric 3×3 matrices (noniterative solver). |
8183
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
82-
| ``if_visual`` | Glace visualization enabler | ``0`` or ``1`` | Take a pop-up glance on the results after computation for check with a rudimentary appearance. |
84+
| | | ``jacobi`` | ``I.P.`` Jacobi eigenvalue algorithm (iterative). |
8385
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
8486

87+
As for your reference, and configured as defaults, the *Berkeley LCS Tutorials* used ``RK4`` for advection, interpolated by ``tricubic``. Although non detailed, ``grad_order=2`` was employed by them from the equation, supposing the mesh is sufficiently refined.
88+
Please always notice that, although providing much better numerical precision and looks cool in papers, high-order methods could be resource-consuming, even hundreds of times.
89+
8590
Dynamic LCS Window
8691
---------------------------------
8792

@@ -97,6 +102,14 @@ Dynamic LCS Window
97102
| ``win_step`` | Window step for dynamic LCS | ``<float>`` | Stepping in frames. Better smaller than ``win_size/2`` for capturing dynamic patterns. |
98103
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
99104

105+
Utilizations
106+
-------------------
107+
108+
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
109+
| Key | Description | Value(s) | Explaination |
110+
+===================+======================================================+=========================+=========================================================================================================+
111+
| ``if_visual`` | Glace visualization enabler | ``0`` or ``1`` | Take a pop-up glance on the results after computation for check with a rudimentary appearance. |
112+
+-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
100113

101114
.. _flow_vars:
102115

0 commit comments

Comments
 (0)