Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
markuswess committed Jun 17, 2024
1 parent 7d0abbb commit 7e4b684
Show file tree
Hide file tree
Showing 18 changed files with 578 additions and 31 deletions.
3 changes: 3 additions & 0 deletions _sources/maxwell/bibliography.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Bibliography
```{bibliography}
```
7 changes: 4 additions & 3 deletions examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="3.1. A plane wave on a square" href="examples/qualitative_dispersion.html" />
<link rel="prev" title="2.6. Time stepping" href="maxwell/time_stepping.html" />
<link rel="prev" title="2.7. Bibliography" href="maxwell/bibliography.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -185,6 +185,7 @@
<li class="toctree-l2"><a class="reference internal" href="maxwell/mass_lumping.html">2.4. Mass lumping</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/diffops.html">2.5. The discrete differential operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/time_stepping.html">2.6. Time stepping</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/bibliography.html">2.7. Bibliography</a></li>
</ul>
</li>
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">3. Examples</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
Expand Down Expand Up @@ -432,12 +433,12 @@ <h1>Examples</h1>

<div class="prev-next-area">
<a class="left-prev"
href="maxwell/time_stepping.html"
href="maxwell/bibliography.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title"><span class="section-number">2.6. </span>Time stepping</p>
<p class="prev-next-title"><span class="section-number">2.7. </span>Bibliography</p>
</div>
</a>
<a class="right-next"
Expand Down
1 change: 1 addition & 0 deletions examples/qualitative_dispersion.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@
<li class="toctree-l2"><a class="reference internal" href="../maxwell/mass_lumping.html">2.4. Mass lumping</a></li>
<li class="toctree-l2"><a class="reference internal" href="../maxwell/diffops.html">2.5. The discrete differential operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="../maxwell/time_stepping.html">2.6. Time stepping</a></li>
<li class="toctree-l2"><a class="reference internal" href="../maxwell/bibliography.html">2.7. Bibliography</a></li>
</ul>
</li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="../examples.html">3. Examples</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
Expand Down
1 change: 1 addition & 0 deletions examples/ring_resonator.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@
<li class="toctree-l2"><a class="reference internal" href="../maxwell/mass_lumping.html">2.4. Mass lumping</a></li>
<li class="toctree-l2"><a class="reference internal" href="../maxwell/diffops.html">2.5. The discrete differential operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="../maxwell/time_stepping.html">2.6. Time stepping</a></li>
<li class="toctree-l2"><a class="reference internal" href="../maxwell/bibliography.html">2.7. Bibliography</a></li>
</ul>
</li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="../examples.html">3. Examples</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
Expand Down
13 changes: 7 additions & 6 deletions examples/waveguide_3d.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@
<li class="toctree-l2"><a class="reference internal" href="maxwell/mass_lumping.html">2.4. Mass lumping</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/diffops.html">2.5. The discrete differential operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/time_stepping.html">2.6. Time stepping</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/bibliography.html">2.7. Bibliography</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="examples.html">3. Examples</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
Expand Down
1 change: 1 addition & 0 deletions installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@
<li class="toctree-l2"><a class="reference internal" href="maxwell/mass_lumping.html">2.4. Mass lumping</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/diffops.html">2.5. The discrete differential operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/time_stepping.html">2.6. Time stepping</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/bibliography.html">2.7. Bibliography</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="examples.html">3. Examples</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
Expand Down
3 changes: 2 additions & 1 deletion intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@
<li class="toctree-l2"><a class="reference internal" href="maxwell/mass_lumping.html">2.4. Mass lumping</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/diffops.html">2.5. The discrete differential operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/time_stepping.html">2.6. Time stepping</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/bibliography.html">2.7. Bibliography</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="examples.html">3. Examples</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
Expand Down Expand Up @@ -410,7 +411,7 @@ <h1>The Dual Cell Method in NGSolve<a class="headerlink" href="#the-dual-cell-me
<hr class="docutils" />
<p>This book is designed to provide an introduction and examples to the implementation of the Dual Cell Method in the high-order finite element library <a class="reference external" href="https://ngsolve.org">NGSolve</a>.</p>
<p>The <em>Dual Cell Method</em> (DCM) is a Galerkin Method for the simulation of time-domain waves (e.g., electromagnetic or acoustiv waves) in mixed formulation. It is a Disconitinuous Galerkin variant where the two wave-fields are approximated by conforming functions on meshes dual to each other. Thus the respective ansatz functions feature discontinuities on different element boundaries.</p>
<p>For a full mathematical introduction to the method we refer to <span id="id1">[<a class="reference internal" href="#id4" title="Bernard Kapidani, Lorenzo Codecasa, and Joachim Schöberl. An arbitrary-order cell method with block-diagonal mass-matrices for the time-dependent 2D Maxwell equations. J. Comput. Phys., 433:Paper No. 110184, 20, 2021. doi:10.1016/j.jcp.2021.110184.">KCSchoberl21</a>, <a class="reference internal" href="#id3" title="Markus Wess, Bernard Kapidani, Lorenzo Codecasa, and Joachim Schöberl. Mass lumping the dual cell method to arbitrary polynomial degree for acoustic and electromagnetic waves. Journal of Computational Physics, pages 113196, 2024. doi:https://doi.org/10.1016/j.jcp.2024.113196.">WKCS24</a>]</span>.</p>
<p>For a full mathematical introduction to the method we refer to <span id="id1">[<a class="reference internal" href="maxwell/bibliography.html#id3" title="Bernard Kapidani, Lorenzo Codecasa, and Joachim Schöberl. An arbitrary-order cell method with block-diagonal mass-matrices for the time-dependent 2D Maxwell equations. J. Comput. Phys., 433:Paper No. 110184, 20, 2021. doi:10.1016/j.jcp.2021.110184.">KCSchoberl21</a>, <a class="reference internal" href="maxwell/bibliography.html#id2" title="Markus Wess, Bernard Kapidani, Lorenzo Codecasa, and Joachim Schöberl. Mass lumping the dual cell method to arbitrary polynomial degree for acoustic and electromagnetic waves. Journal of Computational Physics, pages 113196, 2024. doi:https://doi.org/10.1016/j.jcp.2024.113196.">WKCS24</a>]</span>.</p>
<hr class="docutils" />
<section id="table-of-contents">
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Link to this heading">#</a></h2>
Expand Down
1 change: 1 addition & 0 deletions maxwell.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@
<li class="toctree-l2"><a class="reference internal" href="maxwell/mass_lumping.html">2.4. Mass lumping</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/diffops.html">2.5. The discrete differential operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/time_stepping.html">2.6. Time stepping</a></li>
<li class="toctree-l2"><a class="reference internal" href="maxwell/bibliography.html">2.7. Bibliography</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="examples.html">3. Examples</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
Expand Down
Loading

0 comments on commit 7e4b684

Please sign in to comment.