update

Author: hweifluids

source/1_requirements.rst

@@ -24,7 +24,8 @@ This page summarizes the system requirements and dependencies of NekRS.
 Add-on Libs
 -----------------
 1. **ParaView**
-<ParaView> is a powerful open-source visualization tool that can be used to visualize the results of 3D FTLE computations. We also integrated the ParaView entrance into our GUI, so you can directly open ParaView from it. The ParaView installation-free package (v6.0) can be downloaded from `official <https://www.paraview.org/paraview-downloads/download.php?submit=Download&version=v6.0&type=binary&os=Windows&downloadFile=ParaView-6.0.0-RC1-MPI-Windows-Python3.12-msvc2017-AMD64.zip>`__. 
+
+ParaView is a powerful beloved open-source visualization platform based on vtk that can be used to visualize the results of 3D FTLE computations. We also integrated the ParaView entrance into our GUI, so you can directly open ParaView from it. The ParaView installation-free package (v6.0) can be downloaded from `official <https://www.paraview.org/paraview-downloads/download.php?submit=Download&version=v6.0&type=binary&os=Windows&downloadFile=ParaView-6.0.0-RC1-MPI-Windows-Python3.12-msvc2017-AMD64.zip>`__. 
 
 Quickstart
 -----------------

source/6_inputdeck.rst

@@ -5,27 +5,31 @@ Input Deck for Solver Parameters
 
 To become
 
-================== ============================ =================================================
-Variable Name      Size                         Meaning
-================== ============================ =================================================
-``comm``           1                            MPI communicator
-``device``         1                            backend device
-``dim``            1                            spatial dimension of mesh
-``elementInfo``    ``Nelements``                phase of element (0 = fluid, 1 = solid)
-``EToB``           ``Nelements * Nfaces``       :math:`\checkmark` boundary ID for each face
-``N``              1                            polynomial order for each dimension
-``NboundaryFaces`` 1                            *total* number of faces on a boundary (rank sum)
-``Nelements``      1                            number of elements
-``Nfaces``         1                            number of faces per element
-``Nfp``            1                            number of quadrature points per face
-``Np``             1                            number of quadrature points per element
-``rank``           1                            parallel process rank
-``size``           1                            size of MPI communicator
-``vmapM``          ``Nelements * Nfaces * Nfp`` quadrature point index for faces on boundaries
-``x``              ``Nelements * Np``           :math:`x`-coordinates of quadrature points
-``y``              ``Nelements * Np``           :math:`y`-coordinates of quadrature points
-``z``              ``Nelements * Np``           :math:`z`-coordinates of quadrature points
-================== ============================ =================================================
+========================= ======================================== ============================== ========
+Key                       Description                               Value(s)                        Methods
+========================= ======================================== ============================== ========
+``vtk_folder``             Path to folder containing VTK data files  ``<path>``                       NA
+``output_dir``             Path to directory for saving FTLE results  ``<path>``                       NA
+``auto_wall``              Flag for automatic wall detection (0 = off, 1 = on)  ``0`` or ``1``                 NA
+``wall_xrange``            X-direction wall bounds [xmin, xmax]     ``[<float>, <float>]``         NA
+``wall_yrange``            Y-direction wall bounds [ymin, ymax]     ``[<float>, <float>]``         NA
+``wall_zrange``            Z-direction wall bounds [zmin, zmax]     ``[<float>, <float>]``         NA
+``x``                      Number of seed points in X direction     ``<int>``                       NA
+``y``                      Number of seed points in Y direction     ``<int>``                       NA
+``z``                      Number of seed points in Z direction     ``<int>``                       NA
+``T_range``                Integration time range [Tstart, Tend]    ``[<float>, <float>]``         NA
+``dt``                     Time step for particle advection         ``<float>``                     NA
+``if_backward``            Backward integration flag               ``0`` or ``1``       NA
+``advc_method``            Advection scheme                        ``<string>``                   NA
+``interp_method``          Interpolation method                    ``<string>``                   NA
+``wall_treatment``         Wall-treatment strategy                  ``<string>``                   NA
+``grad_order``             Order of spatial gradient approximation  ``<int>``                       NA
+``Eigen_method``           Eigenvalue computation method           ``<string>``                   NA
+``if_visual``              Visualization flag (0 = off; 1 = on)    ``0`` or ``1``                 NA
+``dyn_mode``               Dynamic LCS mode selector                ``<int>``                       NA
+``win_size``               Window size for dynamic LCS              ``<int> or None``              NA
+``win_step``               Window step for dynamic LCS              ``<int> or None``              NA
+========================= ======================================== ============================== ========
 
 .. _flow_vars: