Skip to content

Commit 776b77b

Browse files
committed
deploy: 0f5c603
1 parent def8383 commit 776b77b

28 files changed

Lines changed: 38 additions & 42 deletions

.doctrees/1_requirements.doctree

850 Bytes
Binary file not shown.

.doctrees/3_numerical.doctree

-27 Bytes
Binary file not shown.

.doctrees/7_command.doctree

1.01 KB
Binary file not shown.

.doctrees/9_references.doctree

444 Bytes
Binary file not shown.

.doctrees/environment.pickle

1.04 KB
Binary file not shown.

.doctrees/index.doctree

-2.25 KB
Binary file not shown.

0_backup.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@
4545
<li class="toctree-l1"><a class="reference internal" href="1_requirements.html">Requirements and Quickstart</a></li>
4646
<li class="toctree-l1"><a class="reference internal" href="2_theory.html">Theory of FTLE and LCS</a></li>
4747
<li class="toctree-l1"><a class="reference internal" href="3_numerical.html">Numerical Methods</a></li>
48-
<li class="toctree-l1"><a class="reference internal" href="3_numerical.html#computational-density-and-comparison">Computational Density and Comparison</a></li>
4948
<li class="toctree-l1"><a class="reference internal" href="4_input.html">Input Data Files</a></li>
5049
<li class="toctree-l1"><a class="reference internal" href="5_gui.html">Graphical User Interface (GUI)</a></li>
5150
<li class="toctree-l1"><a class="reference internal" href="6_inputdeck.html">Input Deck for Solver Parameters</a></li>

1_requirements.html

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,12 @@
4646
<li class="toctree-l1 current"><a class="current reference internal" href="#">Requirements and Quickstart</a><ul>
4747
<li class="toctree-l2"><a class="reference internal" href="#hardware-and-hardware-requirements">Hardware and Hardware Requirements</a></li>
4848
<li class="toctree-l2"><a class="reference internal" href="#basic-environment">Basic Environment</a></li>
49-
<li class="toctree-l2"><a class="reference internal" href="#add-on-libs">Add-on Libs</a></li>
49+
<li class="toctree-l2"><a class="reference internal" href="#add-on-libs-optional">Add-on Libs (Optional)</a></li>
5050
<li class="toctree-l2"><a class="reference internal" href="#quickstart">Quickstart</a></li>
5151
</ul>
5252
</li>
5353
<li class="toctree-l1"><a class="reference internal" href="2_theory.html">Theory of FTLE and LCS</a></li>
5454
<li class="toctree-l1"><a class="reference internal" href="3_numerical.html">Numerical Methods</a></li>
55-
<li class="toctree-l1"><a class="reference internal" href="3_numerical.html#computational-density-and-comparison">Computational Density and Comparison</a></li>
5655
<li class="toctree-l1"><a class="reference internal" href="4_input.html">Input Data Files</a></li>
5756
<li class="toctree-l1"><a class="reference internal" href="5_gui.html">Graphical User Interface (GUI)</a></li>
5857
<li class="toctree-l1"><a class="reference internal" href="6_inputdeck.html">Input Deck for Solver Parameters</a></li>
@@ -133,8 +132,8 @@ <h2>Basic Environment<a class="headerlink" href="#basic-environment" title="Link
133132
</div>
134133
<p>When it does not work, consider if your current dir is incorrect. It should be run from the project root of <code class="docutils literal notranslate"><span class="pre">Py3DFTLE</span></code> when undergoing configurations and under <a class="reference internal" href="7_command.html#command"><span class="std std-ref">command-line</span></a> mode. Please feel free about such thing under GUI mode.</p>
135134
</section>
136-
<section id="add-on-libs">
137-
<h2>Add-on Libs<a class="headerlink" href="#add-on-libs" title="Link to this heading"></a></h2>
135+
<section id="add-on-libs-optional">
136+
<h2>Add-on Libs (Optional)<a class="headerlink" href="#add-on-libs-optional" title="Link to this heading"></a></h2>
138137
<p><strong>1. ParaView</strong> is a powerful beloved open-source visualization platform based on <em>vtk</em> 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.
139138
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>.
140139
For already-installed ParaView, set environment variable <code class="docutils literal notranslate"><span class="pre">PARAVIEW_PATH</span></code> pointing to the root dir of ParaView to enable integration from GUI of <code class="docutils literal notranslate"><span class="pre">Py3DFTLE</span></code>.</p>

2_theory.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@
5050
</ul>
5151
</li>
5252
<li class="toctree-l1"><a class="reference internal" href="3_numerical.html">Numerical Methods</a></li>
53-
<li class="toctree-l1"><a class="reference internal" href="3_numerical.html#computational-density-and-comparison">Computational Density and Comparison</a></li>
5453
<li class="toctree-l1"><a class="reference internal" href="4_input.html">Input Data Files</a></li>
5554
<li class="toctree-l1"><a class="reference internal" href="5_gui.html">Graphical User Interface (GUI)</a></li>
5655
<li class="toctree-l1"><a class="reference internal" href="6_inputdeck.html">Input Deck for Solver Parameters</a></li>

3_numerical.html

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,12 @@
5858
<li class="toctree-l3"><a class="reference internal" href="#eigenvalue-solver">Eigenvalue Solver</a></li>
5959
</ul>
6060
</li>
61+
<li class="toctree-l2"><a class="reference internal" href="#computational-density-and-comparison">Computational Density and Comparison</a><ul>
62+
<li class="toctree-l3"><a class="reference internal" href="#general-tips">General Tips</a></li>
63+
</ul>
64+
</li>
6165
</ul>
6266
</li>
63-
<li class="toctree-l1"><a class="reference internal" href="#computational-density-and-comparison">Computational Density and Comparison</a></li>
6467
<li class="toctree-l1"><a class="reference internal" href="4_input.html">Input Data Files</a></li>
6568
<li class="toctree-l1"><a class="reference internal" href="5_gui.html">Graphical User Interface (GUI)</a></li>
6669
<li class="toctree-l1"><a class="reference internal" href="6_inputdeck.html">Input Deck for Solver Parameters</a></li>
@@ -109,7 +112,7 @@
109112
<section id="time-integration">
110113
<span id="marching"></span><h3>Time Integration<a class="headerlink" href="#time-integration" title="Link to this heading"></a></h3>
111114
<p><strong>Explicit Euler Method</strong></p>
112-
<p>The first-order explicit Euler scheme advances the position by sampling the velocity at the beginning of the time step:</p>
115+
<p>The first-order explicit Euler scheme <code class="docutils literal notranslate"><span class="pre">Euler</span></code> advances the position by sampling the velocity at the beginning of the time step:</p>
113116
<div class="math notranslate nohighlight">
114117
\[\begin{split}\mathbf{u}_n = \mathbf{u}(\mathbf{x}_n,t_n),\\
115118
\mathbf{x}_{n+1} = \mathbf{x}_n + \sigma\,\Delta t\,\mathbf{u}_n.\end{split}\]</div>
@@ -340,13 +343,16 @@
340343
<span id="eigen"></span><h3>Eigenvalue Solver<a class="headerlink" href="#eigenvalue-solver" title="Link to this heading"></a></h3>
341344
</section>
342345
</section>
343-
</section>
344346
<section id="computational-density-and-comparison">
345-
<span id="numcompare"></span><h1>Computational Density and Comparison<a class="headerlink" href="#computational-density-and-comparison" title="Link to this heading"></a></h1>
346-
<p id="numtips">As for your reference, and configured as defaults, the <em>Berkeley LCS Tutorials</em> used <code class="docutils literal notranslate"><span class="pre">RK4</span></code> for advection.
347+
<span id="numcompare"></span><h2>Computational Density and Comparison<a class="headerlink" href="#computational-density-and-comparison" title="Link to this heading"></a></h2>
348+
<section id="general-tips">
349+
<span id="numtips"></span><h3>General Tips<a class="headerlink" href="#general-tips" title="Link to this heading"></a></h3>
350+
<p>As for your reference, and configured as defaults, the <em>Berkeley LCS Tutorials</em> used <code class="docutils literal notranslate"><span class="pre">RK4</span></code> for advection.
347351
The velocity fields were interpolated with <code class="docutils literal notranslate"><span class="pre">tricubic-FL</span></code> by them, originating from <a class="reference internal" href="9_references.html#lekien2005" id="id2"><span>[Lekien2005]</span></a>, which has higher performance by solving a 64×64 linear system using the function values, gradients, and mixed partial derivatives at its eight corners, which is in future development plan for <code class="docutils literal notranslate"><span class="pre">Py3DFTLE</span></code> with high priority.
348352
Although not detailed, <code class="docutils literal notranslate"><span class="pre">grad_order=2</span></code> was employed by them from the equation, supposing the mesh is sufficiently refined.</p>
349353
<p>Please always notice that, although providing much better numerical precision and looks cool in papers, high-order methods could be resource-consuming, even several hundred times.</p>
354+
</section>
355+
</section>
350356
</section>
351357

352358

0 commit comments

Comments
 (0)