Skip to content

Commit bf227a0

Browse files
author
Documenter.jl
committed
build based on 22f9ae5
1 parent 8a8bda8 commit bf227a0

File tree

10 files changed

+66
-21
lines changed

10 files changed

+66
-21
lines changed

dev/.documenter-siteinfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.11.5","generation_timestamp":"2025-05-19T22:04:42","documenter_version":"1.11.4"}}
1+
{"documenter":{"julia_version":"1.11.5","generation_timestamp":"2025-05-19T22:14:08","documenter_version":"1.11.4"}}

dev/api/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

dev/homogeneous/ac147114.png

131 KB
Loading

dev/homogeneous/index.html

Lines changed: 58 additions & 13 deletions
Large diffs are not rendered by default.

dev/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

dev/pa2/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,4 @@
102102
μ = calc_diagram(cv, dh, cst, A, B, n, bz, nevs=5)
103103

104104
# Plot the dispersion diagram
105-
plot_diagram(bz, μ, period=p)</code></pre><img src="262cfe75.png" alt="Example block output"/><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../zhang_case2/">« Inhomogeneous case</a><a class="docs-footer-nextpage" href="../pa3/">PA-Three »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.11.4 on <span class="colophon-date" title="Monday 19 May 2025 22:04">Monday 19 May 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
105+
plot_diagram(bz, μ, period=p)</code></pre><img src="262cfe75.png" alt="Example block output"/><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../zhang_case2/">« Inhomogeneous case</a><a class="docs-footer-nextpage" href="../pa3/">PA-Three »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.11.4 on <span class="colophon-date" title="Monday 19 May 2025 22:14">Monday 19 May 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/pa3/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@
3333
μ = calc_diagram(cv, dh, cst, A, B, n, bz, nevs=6)
3434

3535
# Plot the dispersion diagram
36-
plot_diagram(bz, μ, period=p)</code></pre><img src="54785482.png" alt="Example block output"/><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../pa2/">« PA-Two</a><a class="docs-footer-nextpage" href="../api/">API »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.11.4 on <span class="colophon-date" title="Monday 19 May 2025 22:04">Monday 19 May 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
36+
plot_diagram(bz, μ, period=p)</code></pre><img src="54785482.png" alt="Example block output"/><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../pa2/">« PA-Two</a><a class="docs-footer-nextpage" href="../api/">API »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.11.4 on <span class="colophon-date" title="Monday 19 May 2025 22:14">Monday 19 May 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/references/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

dev/tutorial/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
&amp;\Delta v + 2i\alpha \partial_{1}v + (k^{2}q(x_{1}, x_{2}) - \alpha^{2}) v = 0 \text{ in } \Omega_{0}, \\
77
&amp;\frac{\partial v}{\partial x_{2}} = 0 \text{ on } \partial \Omega_{0}, \\
88
&amp;v \text{ is periodic with respect to } x_{1}.
9-
\end{align*}\]</p><h2 id="Variational-formulation"><a class="docs-heading-anchor" href="#Variational-formulation">Variational formulation</a><a id="Variational-formulation-1"></a><a class="docs-heading-anchor-permalink" href="#Variational-formulation" title="Permalink"></a></h2><p>In this section, we present the variational formulation of the boundary value problem: Find <span>$v \in H_{per}^{1}(\Omega_{0})$</span> satisfying</p><p class="math-container">\[\int_{\Omega_{0}} \nabla v \cdot \nabla \bar{\phi} - 2i\alpha \partial_{1} v \bar{\phi} - (k^{2}q(x_{1}, x_{2}) - \alpha^{2}) v \bar{\phi} dx = 0.\]</p><p>After finite element discretization, we can obtain a generalized linear eigenvalue problem</p><p class="math-container">\[\mathbf{A}_{\alpha} \mathbf{v} = k^{2} \mathbf{B} \mathbf{v},\]</p><p>where <span>$\mathbf{A}_{\alpha}$</span> comes from</p><p class="math-container">\[\int_{\Omega_{0}} \nabla v \cdot \nabla \bar{\phi} - 2i\alpha \partial_{1} v \bar{\phi} + \alpha^{2} v \bar{\phi} dx \]</p><p>and <span>$\mathbf{B}$</span> comes from</p><p class="math-container">\[\int_{\Omega_{0}} q(x_{1}, x_{2}) v \bar{\phi} dx.\]</p><div class="admonition is-info" id="important-steps-in-the-computation-21d31f66c14e893a"><header class="admonition-header">important steps in the computation<a class="admonition-anchor" href="#important-steps-in-the-computation-21d31f66c14e893a" title="Permalink"></a></header><div class="admonition-body"><ul><li>We use the Finite element method to discretize the variational formulation. In ClosedWaveguideDispersion.jl, all Finite element codes are implemented by <a href="https://github.com/Ferrite-FEM/Ferrite.jl">Ferrite.jl</a></li><li>After the Finite element discretization, we obtain a generalized linear eigenvalue problem parametered by <span>$\alpha$</span>. We utilize <a href="https://github.com/JuliaLinearAlgebra/Arpack.jl">Arpack.jl</a> to solve the generalized linear eigenvalue problems with fixed <span>$\alpha$</span>.</li></ul></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../homogeneous/">Homogeneous case with Neumann boundary condition »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.11.4 on <span class="colophon-date" title="Monday 19 May 2025 22:04">Monday 19 May 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
9+
\end{align*}\]</p><h2 id="Variational-formulation"><a class="docs-heading-anchor" href="#Variational-formulation">Variational formulation</a><a id="Variational-formulation-1"></a><a class="docs-heading-anchor-permalink" href="#Variational-formulation" title="Permalink"></a></h2><p>In this section, we present the variational formulation of the boundary value problem: Find <span>$v \in H_{per}^{1}(\Omega_{0})$</span> satisfying</p><p class="math-container">\[\int_{\Omega_{0}} \nabla v \cdot \nabla \bar{\phi} - 2i\alpha \partial_{1} v \bar{\phi} - (k^{2}q(x_{1}, x_{2}) - \alpha^{2}) v \bar{\phi} dx = 0.\]</p><p>After finite element discretization, we can obtain a generalized linear eigenvalue problem</p><p class="math-container">\[\mathbf{A}_{\alpha} \mathbf{v} = k^{2} \mathbf{B} \mathbf{v},\]</p><p>where <span>$\mathbf{A}_{\alpha}$</span> comes from</p><p class="math-container">\[\int_{\Omega_{0}} \nabla v \cdot \nabla \bar{\phi} - 2i\alpha \partial_{1} v \bar{\phi} + \alpha^{2} v \bar{\phi} dx \]</p><p>and <span>$\mathbf{B}$</span> comes from</p><p class="math-container">\[\int_{\Omega_{0}} q(x_{1}, x_{2}) v \bar{\phi} dx.\]</p><div class="admonition is-info" id="important-steps-in-the-computation-21d31f66c14e893a"><header class="admonition-header">important steps in the computation<a class="admonition-anchor" href="#important-steps-in-the-computation-21d31f66c14e893a" title="Permalink"></a></header><div class="admonition-body"><ul><li>We use the Finite element method to discretize the variational formulation. In ClosedWaveguideDispersion.jl, all Finite element codes are implemented by <a href="https://github.com/Ferrite-FEM/Ferrite.jl">Ferrite.jl</a></li><li>After the Finite element discretization, we obtain a generalized linear eigenvalue problem parametered by <span>$\alpha$</span>. We utilize <a href="https://github.com/JuliaLinearAlgebra/Arpack.jl">Arpack.jl</a> to solve the generalized linear eigenvalue problems with fixed <span>$\alpha$</span>.</li></ul></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../homogeneous/">Homogeneous case with Neumann boundary condition »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.11.4 on <span class="colophon-date" title="Monday 19 May 2025 22:14">Monday 19 May 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/zhang_case2/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,4 @@
7474
1.91114 4.47794 6.31192 13.1848 15.8586 19.802 22.2934
7575
1.92551 4.46018 6.32281 13.1704 15.8692 19.9133 22.183
7676
1.93232 4.45248 6.3289 13.1637 15.8762 19.9986 22.1028</code></pre><p>Finally, we can get our dispersion diagram.</p><pre><code class="language-julia hljs"># Plot the dispersion diagram
77-
plot_diagram(bz, μ, period=p)</code></pre><img src="ad95dfa4.png" alt="Example block output"/><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../homogeneous/">« Homogeneous case with Neumann boundary condition</a><a class="docs-footer-nextpage" href="../pa2/">PA-Two »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.11.4 on <span class="colophon-date" title="Monday 19 May 2025 22:04">Monday 19 May 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
77+
plot_diagram(bz, μ, period=p)</code></pre><img src="ad95dfa4.png" alt="Example block output"/><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../homogeneous/">« Homogeneous case with Neumann boundary condition</a><a class="docs-footer-nextpage" href="../pa2/">PA-Two »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.11.4 on <span class="colophon-date" title="Monday 19 May 2025 22:14">Monday 19 May 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)