Skip to content

Commit 20670a3

Browse files
hweifluidshweifluids
committed
deploy: 3c9c1d9 
1 parent db1506b commit 20670a3

File tree

8 files changed

+32
-104
lines changed

8 files changed

+32
-104
lines changed

‎.doctrees/1_requirements.doctree‎

239 Bytes
Binary file not shown.

‎.doctrees/6_inputdeck.doctree‎

-7.41 KB
Binary file not shown.

‎.doctrees/environment.pickle‎

0 Bytes
Binary file not shown.

‎1_requirements.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,10 @@ <h2>Basic Environment<a class="headerlink" href="#basic-environment" title="Link
103103
</section>
104104
<section id="add-on-libs">
105105
<h2>Add-on Libs<a class="headerlink" href="#add-on-libs" title="Link to this heading"></a></h2>
106-
<p>1. <strong>ParaView</strong>
107-
&lt;ParaView&gt; 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 <a class="reference external" href="https://www.paraview.org/paraview-downloads/download.php?submit=Download&amp;version=v6.0&amp;type=binary&amp;os=Windows&amp;downloadFile=ParaView-6.0.0-RC1-MPI-Windows-Python3.12-msvc2017-AMD64.zip">official</a>.</p>
106+
<ol class="arabic simple">
107+
<li><p><strong>ParaView</strong></p></li>
108+
</ol>
109+
<p>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 <a class="reference external" href="https://www.paraview.org/paraview-downloads/download.php?submit=Download&amp;version=v6.0&amp;type=binary&amp;os=Windows&amp;downloadFile=ParaView-6.0.0-RC1-MPI-Windows-Python3.12-msvc2017-AMD64.zip">official</a>.</p>
108110
</section>
109111
<section id="quickstart">
110112
<h2>Quickstart<a class="headerlink" href="#quickstart" title="Link to this heading"></a></h2>

‎6_inputdeck.html‎

Lines changed: 0 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
<script src="_static/documentation_options.js?v=2709fde1"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
19-
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
2019
<script src="_static/js/theme.js"></script>
2120
<link rel="index" title="Index" href="genindex.html" />
2221
<link rel="search" title="Search" href="search.html" />
@@ -82,84 +81,6 @@
8281
<section id="input-deck-for-solver-parameters">
8382
<span id="inputdeck"></span><h1>Input Deck for Solver Parameters<a class="headerlink" href="#input-deck-for-solver-parameters" title="Link to this heading"></a></h1>
8483
<p>To become</p>
85-
<table class="docutils align-default">
86-
<thead>
87-
<tr class="row-odd"><th class="head"><p>Variable Name</p></th>
88-
<th class="head"><p>Size</p></th>
89-
<th class="head"><p>Meaning</p></th>
90-
</tr>
91-
</thead>
92-
<tbody>
93-
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">comm</span></code></p></td>
94-
<td><p>1</p></td>
95-
<td><p>MPI communicator</p></td>
96-
</tr>
97-
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">device</span></code></p></td>
98-
<td><p>1</p></td>
99-
<td><p>backend device</p></td>
100-
</tr>
101-
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">dim</span></code></p></td>
102-
<td><p>1</p></td>
103-
<td><p>spatial dimension of mesh</p></td>
104-
</tr>
105-
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">elementInfo</span></code></p></td>
106-
<td><p><code class="docutils literal notranslate"><span class="pre">Nelements</span></code></p></td>
107-
<td><p>phase of element (0 = fluid, 1 = solid)</p></td>
108-
</tr>
109-
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">EToB</span></code></p></td>
110-
<td><p><code class="docutils literal notranslate"><span class="pre">Nelements</span> <span class="pre">*</span> <span class="pre">Nfaces</span></code></p></td>
111-
<td><p><span class="math notranslate nohighlight">\(\checkmark\)</span> boundary ID for each face</p></td>
112-
</tr>
113-
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">N</span></code></p></td>
114-
<td><p>1</p></td>
115-
<td><p>polynomial order for each dimension</p></td>
116-
</tr>
117-
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">NboundaryFaces</span></code></p></td>
118-
<td><p>1</p></td>
119-
<td><p><em>total</em> number of faces on a boundary (rank sum)</p></td>
120-
</tr>
121-
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">Nelements</span></code></p></td>
122-
<td><p>1</p></td>
123-
<td><p>number of elements</p></td>
124-
</tr>
125-
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">Nfaces</span></code></p></td>
126-
<td><p>1</p></td>
127-
<td><p>number of faces per element</p></td>
128-
</tr>
129-
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">Nfp</span></code></p></td>
130-
<td><p>1</p></td>
131-
<td><p>number of quadrature points per face</p></td>
132-
</tr>
133-
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">Np</span></code></p></td>
134-
<td><p>1</p></td>
135-
<td><p>number of quadrature points per element</p></td>
136-
</tr>
137-
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">rank</span></code></p></td>
138-
<td><p>1</p></td>
139-
<td><p>parallel process rank</p></td>
140-
</tr>
141-
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">size</span></code></p></td>
142-
<td><p>1</p></td>
143-
<td><p>size of MPI communicator</p></td>
144-
</tr>
145-
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">vmapM</span></code></p></td>
146-
<td><p><code class="docutils literal notranslate"><span class="pre">Nelements</span> <span class="pre">*</span> <span class="pre">Nfaces</span> <span class="pre">*</span> <span class="pre">Nfp</span></code></p></td>
147-
<td><p>quadrature point index for faces on boundaries</p></td>
148-
</tr>
149-
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">x</span></code></p></td>
150-
<td><p><code class="docutils literal notranslate"><span class="pre">Nelements</span> <span class="pre">*</span> <span class="pre">Np</span></code></p></td>
151-
<td><p><span class="math notranslate nohighlight">\(x\)</span>-coordinates of quadrature points</p></td>
152-
</tr>
153-
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">y</span></code></p></td>
154-
<td><p><code class="docutils literal notranslate"><span class="pre">Nelements</span> <span class="pre">*</span> <span class="pre">Np</span></code></p></td>
155-
<td><p><span class="math notranslate nohighlight">\(y\)</span>-coordinates of quadrature points</p></td>
156-
</tr>
157-
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">z</span></code></p></td>
158-
<td><p><code class="docutils literal notranslate"><span class="pre">Nelements</span> <span class="pre">*</span> <span class="pre">Np</span></code></p></td>
159-
<td><p><span class="math notranslate nohighlight">\(z\)</span>-coordinates of quadrature points</p></td>
160-
</tr>
161-
</tbody>
162-
</table>
16384
<p id="flow-vars">Flow So</p>
16485
</section>
16586

‎_sources/1_requirements.rst.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ This page summarizes the system requirements and dependencies of NekRS.
2424
Add-on Libs
2525
-----------------
2626
1. **ParaView**
27-
<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>`__.
27+
28+
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>`__.
2829

2930
Quickstart
3031
-----------------

‎_sources/6_inputdeck.rst.txt‎

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,31 @@ Input Deck for Solver Parameters
55

66
To become
77

8-
================== ============================ =================================================
9-
Variable Name Size Meaning
10-
================== ============================ =================================================
11-
``comm`` 1 MPI communicator
12-
``device`` 1 backend device
13-
``dim`` 1 spatial dimension of mesh
14-
``elementInfo`` ``Nelements`` phase of element (0 = fluid, 1 = solid)
15-
``EToB`` ``Nelements * Nfaces`` :math:`\checkmark` boundary ID for each face
16-
``N`` 1 polynomial order for each dimension
17-
``NboundaryFaces`` 1 *total* number of faces on a boundary (rank sum)
18-
``Nelements`` 1 number of elements
19-
``Nfaces`` 1 number of faces per element
20-
``Nfp`` 1 number of quadrature points per face
21-
``Np`` 1 number of quadrature points per element
22-
``rank`` 1 parallel process rank
23-
``size`` 1 size of MPI communicator
24-
``vmapM`` ``Nelements * Nfaces * Nfp`` quadrature point index for faces on boundaries
25-
``x`` ``Nelements * Np`` :math:`x`-coordinates of quadrature points
26-
``y`` ``Nelements * Np`` :math:`y`-coordinates of quadrature points
27-
``z`` ``Nelements * Np`` :math:`z`-coordinates of quadrature points
28-
================== ============================ =================================================
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+
========================= ======================================== ============================== ========
2933

3034
.. _flow_vars:
3135

0 commit comments

Comments
 (0)