Skip to content

Commit

Permalink
build based on b7e3db7
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jul 17, 2023
1 parent 22be310 commit bb313c6
Show file tree
Hide file tree
Showing 13 changed files with 113 additions and 18,128 deletions.
4 changes: 2 additions & 2 deletions dev/api/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · AnnA.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.039/juliamono-regular.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">AnnA.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><span class="tocitem">Working principle</span><ul><li><a class="tocitem" href="../working_principle/physical_concepts/">Physical Concepts</a></li><li><a class="tocitem" href="../working_principle/finite_element_scheme/">Finite Element Scheme</a></li></ul></li><li><span class="tocitem">Interface</span><ul><li><a class="tocitem" href="../interface/parameters/">Simulation parameters</a></li><li><a class="tocitem" href="../interface/problems/">Problem definition</a></li></ul></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../examples/proto_sim/">Problems</a></li></ul></li><li class="is-active"><a class="tocitem" href>API</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/MatFi/AnnA.jl/blob/master/docs/src/api.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><article class="docstring"><header><a class="docstring-binding" id="AnnA.Pulse" href="#AnnA.Pulse"><code>AnnA.Pulse</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct Pulse{A, AA, T, TT, I} &lt;: Function</code></pre><p>Holds all information about the pulse formation.</p><p><strong>Arguments:</strong></p><ul><li><code>Δh</code>: Pulse Amplitude</li><li><code>h₀</code>: Baseline</li><li><code>w</code>: Pulse width</li><li><code>Δt</code>: rise and fall time</li><li><code>tₑ</code>: end time (end of fall)</li><li><code>ts</code>: array of timepoints</li><li><code>hs</code>: array of amplitude points</li><li><code>itp</code>: interploating function</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MatFi/AnnA.jl/blob/789d0801087050b08fe304f3686e4b07aba8f08f/src/routines/helpers.jl#L31-L45">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AnnA.Pulse-Tuple{Any}" href="#AnnA.Pulse-Tuple{Any}"><code>AnnA.Pulse</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">(p::Pulse)(t)</code></pre><p>calls the interpolating function from <code>Pulse</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MatFi/AnnA.jl/blob/789d0801087050b08fe304f3686e4b07aba8f08f/src/routines/helpers.jl#L56-L60">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LinearAlgebra.Tridiagonal-Union{Tuple{T}, Tuple{L}, Tuple{Integer, T, T, T}} where {L&lt;:Number, T&lt;:Union{AbstractVector{L}, Number}}" href="#LinearAlgebra.Tridiagonal-Union{Tuple{T}, Tuple{L}, Tuple{Integer, T, T, T}} where {L&lt;:Number, T&lt;:Union{AbstractVector{L}, Number}}"><code>LinearAlgebra.Tridiagonal</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">(LinearAlgebra.Tridiagonal(N::Integer, a::T, b::T, c::T) where T &lt;: Union{Number, AbstractArray{L, 1}}) where L &lt;: Number</code></pre><p>A simple wrapper for creating tridiagonal matrices a bit more convineantly</p><p><strong>Arguments:</strong></p><ul><li><code>N</code>: Size of the NxN tridiagonal</li><li><code>a</code>: row a</li><li><code>b</code>: row b</li><li><code>c</code>: row c</li></ul><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">julia&gt; AnnA.Tridiagonal(4,1,-2,-1)
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · AnnA.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">AnnA.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><span class="tocitem">Working principle</span><ul><li><a class="tocitem" href="../working_principle/physical_concepts/">Physical Concepts</a></li><li><a class="tocitem" href="../working_principle/finite_element_scheme/">Finite Element Scheme</a></li></ul></li><li><span class="tocitem">Interface</span><ul><li><a class="tocitem" href="../interface/parameters/">Simulation parameters</a></li><li><a class="tocitem" href="../interface/problems/">Problem definition</a></li></ul></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../examples/proto_sim/">Problems</a></li></ul></li><li class="is-active"><a class="tocitem" href>API</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/MatFi/AnnA.jl/blob/master/docs/src/api.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><article class="docstring"><header><a class="docstring-binding" id="AnnA.Pulse" href="#AnnA.Pulse"><code>AnnA.Pulse</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct Pulse{A, AA, T, TT, I} &lt;: Function</code></pre><p>Holds all information about the pulse formation.</p><p><strong>Arguments:</strong></p><ul><li><code>Δh</code>: Pulse Amplitude</li><li><code>h₀</code>: Baseline</li><li><code>w</code>: Pulse width</li><li><code>Δt</code>: rise and fall time</li><li><code>tₑ</code>: end time (end of fall)</li><li><code>ts</code>: array of timepoints</li><li><code>hs</code>: array of amplitude points</li><li><code>itp</code>: interploating function</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MatFi/AnnA.jl/blob/b7e3db79ca627c9cc9e78fb10b8ef98cf887a203/src/routines/helpers.jl#L31-L45">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AnnA.Pulse-Tuple{Any}" href="#AnnA.Pulse-Tuple{Any}"><code>AnnA.Pulse</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">(p::Pulse)(t)</code></pre><p>calls the interpolating function from <code>Pulse</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MatFi/AnnA.jl/blob/b7e3db79ca627c9cc9e78fb10b8ef98cf887a203/src/routines/helpers.jl#L56-L60">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LinearAlgebra.Tridiagonal-Union{Tuple{T}, Tuple{L}, Tuple{Integer, T, T, T}} where {L&lt;:Number, T&lt;:Union{AbstractVector{L}, Number}}" href="#LinearAlgebra.Tridiagonal-Union{Tuple{T}, Tuple{L}, Tuple{Integer, T, T, T}} where {L&lt;:Number, T&lt;:Union{AbstractVector{L}, Number}}"><code>LinearAlgebra.Tridiagonal</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">(LinearAlgebra.Tridiagonal(N::Integer, a::T, b::T, c::T) where T &lt;: Union{Number, AbstractArray{L, 1}}) where L &lt;: Number</code></pre><p>A simple wrapper for creating tridiagonal matrices a bit more convineantly</p><p><strong>Arguments:</strong></p><ul><li><code>N</code>: Size of the NxN tridiagonal</li><li><code>a</code>: row a</li><li><code>b</code>: row b</li><li><code>c</code>: row c</li></ul><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">julia&gt; AnnA.Tridiagonal(4,1,-2,-1)
4×4 LinearAlgebra.Tridiagonal{Int64, Vector{Int64}}:
-2 -1 ⋅ ⋅
1 -2 -1 ⋅
⋅ 1 -2 -1
⋅ ⋅ 1 -2</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MatFi/AnnA.jl/blob/789d0801087050b08fe304f3686e4b07aba8f08f/src/routines/helpers.jl#L1-L21">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../examples/proto_sim/">« Problems</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.10 on <span class="colophon-date" title="Tuesday 2 November 2021 21:48">Tuesday 2 November 2021</span>. Using Julia version 1.6.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
⋅ ⋅ 1 -2</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MatFi/AnnA.jl/blob/b7e3db79ca627c9cc9e78fb10b8ef98cf887a203/src/routines/helpers.jl#L1-L21">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../examples/proto_sim/">« Problems</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Monday 17 July 2023 20:53">Monday 17 July 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
77 changes: 72 additions & 5 deletions dev/assets/documenter.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit bb313c6

Please sign in to comment.