Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Movement docs #21

Merged
merged 4 commits into from
Jan 15, 2024
+3,158 −332
Merged

Add Movement docs #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9728afc
Add Movement to index
jwallwork23 Jan 12, 2024
236c307
Add movement to conf
jwallwork23 Jan 12, 2024
5807408
Add Movement to Makefile
jwallwork23 Jan 12, 2024
b1a7f3f
Build website
jwallwork23 Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added _images/monge_ampere1-adapted_mesh.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/monge_ampere1-initial_mesh.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 4 additions & 6 deletions _modules/goalie/adjoint.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>goalie.adjoint &#8212; Animate and Goalie 0.1 documentation</title>
<title>goalie.adjoint &#8212; Animate, Movement and Goalie 0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/nature.css?v=601dbdee" />
<script src="../../_static/documentation_options.js?v=2709fde1"></script>
Expand All @@ -22,7 +22,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Animate and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Animate, Movement and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">goalie.adjoint</a></li>
</ul>
Expand Down Expand Up @@ -434,9 +434,7 @@ <h1>Source code for goalie.adjoint</h1><div class="highlight"><pre>
<span class="p">)</span>
<span class="k">elif</span> <span class="n">j</span> <span class="o">*</span> <span class="n">stride</span> <span class="o">+</span> <span class="mi">1</span> <span class="o">==</span> <span class="n">num_solve_blocks</span><span class="p">:</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">+</span> <span class="mi">1</span> <span class="o">&lt;</span> <span class="n">num_subintervals</span><span class="p">:</span>
<span class="n">sols</span><span class="o">.</span><span class="n">adjoint_next</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span><span class="o">.</span><span class="n">project</span><span class="p">(</span>
<span class="n">sols</span><span class="o">.</span><span class="n">adjoint_next</span><span class="p">[</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">][</span><span class="mi">0</span><span class="p">],</span> <span class="n">fs</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
<span class="p">)</span>
<span class="n">sols</span><span class="o">.</span><span class="n">adjoint_next</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span><span class="o">.</span><span class="n">project</span><span class="p">(</span><span class="n">sols</span><span class="o">.</span><span class="n">adjoint_next</span><span class="p">[</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">][</span><span class="mi">0</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">IndexError</span><span class="p">(</span>
<span class="s2">&quot;Cannot extract solve block&quot;</span>
Expand Down Expand Up @@ -560,7 +558,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Animate and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Animate, Movement and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">goalie.adjoint</a></li>
</ul>
Expand Down
122 changes: 43 additions & 79 deletions _modules/goalie/go_mesh_seq.html
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions _modules/goalie/mesh_seq.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>goalie.mesh_seq &#8212; Animate and Goalie 0.1 documentation</title>
<title>goalie.mesh_seq &#8212; Animate, Movement and Goalie 0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/nature.css?v=601dbdee" />
<script src="../../_static/documentation_options.js?v=2709fde1"></script>
Expand All @@ -22,7 +22,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Animate and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Animate, Movement and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">goalie.mesh_seq</a></li>
</ul>
Expand Down Expand Up @@ -211,11 +211,11 @@ <h1>Source code for goalie.mesh_seq</h1><div class="highlight"><pre>

<span class="sd"> :kwarg fig: matplotlib figure</span>
<span class="sd"> :kwarg axes: matplotlib axes</span>
<span class="sd"> :kwargs: parameters to pass to :func:`firedrake.plot.triplot`</span>
<span class="sd"> function</span>
<span class="sd"> :kwargs: parameters to pass to :func:`firedrake.plot.triplot` function</span>
<span class="sd"> :return: matplotlib figure and axes for the plots</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">matplotlib.pyplot</span> <span class="kn">import</span> <span class="n">subplots</span>
<span class="kn">from</span> <span class="nn">firedrake.pyplot</span> <span class="kn">import</span> <span class="n">triplot</span>

<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">dim</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;MeshSeq plotting only supported in 2D&quot;</span><span class="p">)</span>
Expand All @@ -242,7 +242,7 @@ <h1>Source code for goalie.mesh_seq</h1><div class="highlight"><pre>
<span class="n">axis</span> <span class="o">=</span> <span class="p">[</span><span class="n">axis</span><span class="p">]</span>
<span class="k">for</span> <span class="n">ax</span> <span class="ow">in</span> <span class="n">axis</span><span class="p">:</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;MeshSeq[</span><span class="si">{</span><span class="n">k</span><span class="si">}</span><span class="s2">]&quot;</span><span class="p">)</span>
<span class="n">firedrake</span><span class="o">.</span><span class="n">triplot</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">meshes</span><span class="p">[</span><span class="n">k</span><span class="p">],</span> <span class="n">axes</span><span class="o">=</span><span class="n">ax</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">triplot</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">meshes</span><span class="p">[</span><span class="n">k</span><span class="p">],</span> <span class="n">axes</span><span class="o">=</span><span class="n">ax</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="n">k</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">axis</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
Expand Down Expand Up @@ -824,7 +824,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Animate and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Animate, Movement and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">goalie.mesh_seq</a></li>
</ul>
Expand Down
10 changes: 5 additions & 5 deletions _modules/goalie/plot.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>goalie.plot &#8212; Animate and Goalie 0.1 documentation</title>
<title>goalie.plot &#8212; Animate, Movement and Goalie 0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/nature.css?v=601dbdee" />
<script src="../../_static/documentation_options.js?v=2709fde1"></script>
Expand All @@ -22,7 +22,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Animate and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Animate, Movement and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">goalie.plot</a></li>
</ul>
Expand All @@ -37,7 +37,7 @@ <h1>Source code for goalie.plot</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Driver functions for plotting solution data.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">firedrake</span> <span class="kn">import</span> <span class="n">tricontourf</span><span class="p">,</span> <span class="n">triplot</span> <span class="c1"># noqa</span>
<span class="kn">from</span> <span class="nn">firedrake.pyplot</span> <span class="kn">import</span> <span class="n">tricontourf</span><span class="p">,</span> <span class="n">triplot</span> <span class="c1"># noqa</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>


Expand Down Expand Up @@ -160,13 +160,13 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Animate and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Animate, Movement and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">goalie.plot</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2021-2023, Joseph G. Wallwork et al..
&#169; Copyright 2021-2024, Joseph G. Wallwork et al..
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
Expand Down
11 changes: 8 additions & 3 deletions _modules/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; Animate and Goalie 0.1 documentation</title>
<title>Overview: module code &#8212; Animate, Movement and Goalie 0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=601dbdee" />
<script src="../_static/documentation_options.js?v=2709fde1"></script>
Expand All @@ -22,7 +22,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Animate and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Animate, Movement and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
</ul>
</div>
Expand Down Expand Up @@ -52,6 +52,11 @@ <h1>All modules for which code is available</h1>
<li><a href="goalie/time_partition.html">goalie.time_partition</a></li>
<li><a href="goalie/utility.html">goalie.utility</a></li>
<li><a href="logging.html">logging</a></li>
<li><a href="movement/laplacian.html">movement.laplacian</a></li>
<li><a href="movement/monge_ampere.html">movement.monge_ampere</a></li>
<li><a href="movement/mover.html">movement.mover</a></li>
<li><a href="movement/spring.html">movement.spring</a></li>
<li><a href="movement/tangling.html">movement.tangling</a></li>
</ul>

<div class="clearer"></div>
Expand Down Expand Up @@ -83,7 +88,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Animate and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Animate, Movement and Goalie 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
</ul>
</div>
Expand Down
Loading