build based on 660e384

previews/PR1113/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-12-02T12:11:55","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-12-02T12:15:44","documenter_version":"1.7.0"}}

previews/PR1113/devdocs/special_datastructures/index.html

@@ -3,4 +3,4 @@
     for (ind, val) in some_data
         push_at_index!(buffer, val, ind)
     end
-end</code></pre><p><code>sizehint</code> tells how much space to allocate for the index <code>ind</code> if no <code>val</code> has been added to that index before, or how much more space to allocate in case all previously allocated space for <code>ind</code> has been used up.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Ferrite-FEM/Ferrite.jl/blob/c31d98ac0917966c28fc6bb895e1a0509b8db9c2/src/CollectionsOfViews.jl#L85-L104">source</a></section><section><div><pre><code class="language-julia hljs">ArrayOfVectorViews(b::CollectionsOfViews.ConstructionBuffer)</code></pre><p>Creates the <code>ArrayOfVectorViews</code> directly from the <code>ConstructionBuffer</code> that was manually created and filled.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Ferrite-FEM/Ferrite.jl/blob/c31d98ac0917966c28fc6bb895e1a0509b8db9c2/src/CollectionsOfViews.jl#L112-L116">source</a></section><section><div><pre><code class="language-julia hljs">ArrayOfVectorViews(indices::Vector{Int}, data::Vector{T}, lin_idx::LinearIndices{N}; checkargs = true)</code></pre><p>Creates the <code>ArrayOfVectorViews</code> directly where the user is responsible for having the correct input data. Checking of the argument dimensions can be elided by setting <code>checkargs = false</code>, but incorrect dimensions may lead to illegal out of bounds access later.</p><p><code>data</code> is indexed by <code>indices[i]:indices[i+1]</code>, where <code>i = lin_idx[idx...]</code> and <code>idx...</code> are the user-provided indices to the <code>ArrayOfVectorViews</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Ferrite-FEM/Ferrite.jl/blob/c31d98ac0917966c28fc6bb895e1a0509b8db9c2/src/CollectionsOfViews.jl#L137-L146">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Ferrite.CollectionsOfViews.ConstructionBuffer" href="#Ferrite.CollectionsOfViews.ConstructionBuffer"><code>Ferrite.CollectionsOfViews.ConstructionBuffer</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstructionBuffer(data::Vector, dims::NTuple{N, Int}, sizehint)</code></pre><p>Create a buffer for creating an <a href="#ArrayOfVectorViews"><code>ArrayOfVectorViews</code></a>, representing an array with <code>N</code> axes. <code>sizehint</code> sets the number of elements in <code>data</code> allocated when a new index is added via <code>push_at_index!</code>, or when the current storage for the index is full, how much many additional elements are reserved for that index. Any content in <code>data</code> is overwritten, but performance is improved by pre-allocating it to a reasonable size or by <code>sizehint!</code>ing it.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Ferrite-FEM/Ferrite.jl/blob/c31d98ac0917966c28fc6bb895e1a0509b8db9c2/src/CollectionsOfViews.jl#L19-L27">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Ferrite.CollectionsOfViews.push_at_index!" href="#Ferrite.CollectionsOfViews.push_at_index!"><code>Ferrite.CollectionsOfViews.push_at_index!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">push_at_index!(b::ConstructionBuffer, val, indices::Int...)</code></pre><p><code>push!</code> the value <code>val</code> to the <code>Vector</code> view at the index given by <code>indices</code>, typically called inside the <a href="#ArrayOfVectorViews"><code>ArrayOfVectorViews</code></a> constructor do-block. But can also be used when manually creating a <code>ConstructionBuffer</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Ferrite-FEM/Ferrite.jl/blob/c31d98ac0917966c28fc6bb895e1a0509b8db9c2/src/CollectionsOfViews.jl#L33-L39">source</a></section></article></article><nav class="docs-footer"><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.7.0 on <span class="colophon-date" title="Monday 2 December 2024 12:11">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre><p><code>sizehint</code> tells how much space to allocate for the index <code>ind</code> if no <code>val</code> has been added to that index before, or how much more space to allocate in case all previously allocated space for <code>ind</code> has been used up.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Ferrite-FEM/Ferrite.jl/blob/660e38472068094168f8700114dfa0b5cd4615e5/src/CollectionsOfViews.jl#L85-L104">source</a></section><section><div><pre><code class="language-julia hljs">ArrayOfVectorViews(b::CollectionsOfViews.ConstructionBuffer)</code></pre><p>Creates the <code>ArrayOfVectorViews</code> directly from the <code>ConstructionBuffer</code> that was manually created and filled.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Ferrite-FEM/Ferrite.jl/blob/660e38472068094168f8700114dfa0b5cd4615e5/src/CollectionsOfViews.jl#L112-L116">source</a></section><section><div><pre><code class="language-julia hljs">ArrayOfVectorViews(indices::Vector{Int}, data::Vector{T}, lin_idx::LinearIndices{N}; checkargs = true)</code></pre><p>Creates the <code>ArrayOfVectorViews</code> directly where the user is responsible for having the correct input data. Checking of the argument dimensions can be elided by setting <code>checkargs = false</code>, but incorrect dimensions may lead to illegal out of bounds access later.</p><p><code>data</code> is indexed by <code>indices[i]:indices[i+1]</code>, where <code>i = lin_idx[idx...]</code> and <code>idx...</code> are the user-provided indices to the <code>ArrayOfVectorViews</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Ferrite-FEM/Ferrite.jl/blob/660e38472068094168f8700114dfa0b5cd4615e5/src/CollectionsOfViews.jl#L137-L146">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Ferrite.CollectionsOfViews.ConstructionBuffer" href="#Ferrite.CollectionsOfViews.ConstructionBuffer"><code>Ferrite.CollectionsOfViews.ConstructionBuffer</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstructionBuffer(data::Vector, dims::NTuple{N, Int}, sizehint)</code></pre><p>Create a buffer for creating an <a href="#ArrayOfVectorViews"><code>ArrayOfVectorViews</code></a>, representing an array with <code>N</code> axes. <code>sizehint</code> sets the number of elements in <code>data</code> allocated when a new index is added via <code>push_at_index!</code>, or when the current storage for the index is full, how much many additional elements are reserved for that index. Any content in <code>data</code> is overwritten, but performance is improved by pre-allocating it to a reasonable size or by <code>sizehint!</code>ing it.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Ferrite-FEM/Ferrite.jl/blob/660e38472068094168f8700114dfa0b5cd4615e5/src/CollectionsOfViews.jl#L19-L27">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Ferrite.CollectionsOfViews.push_at_index!" href="#Ferrite.CollectionsOfViews.push_at_index!"><code>Ferrite.CollectionsOfViews.push_at_index!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">push_at_index!(b::ConstructionBuffer, val, indices::Int...)</code></pre><p><code>push!</code> the value <code>val</code> to the <code>Vector</code> view at the index given by <code>indices</code>, typically called inside the <a href="#ArrayOfVectorViews"><code>ArrayOfVectorViews</code></a> constructor do-block. But can also be used when manually creating a <code>ConstructionBuffer</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Ferrite-FEM/Ferrite.jl/blob/660e38472068094168f8700114dfa0b5cd4615e5/src/CollectionsOfViews.jl#L33-L39">source</a></section></article></article><nav class="docs-footer"><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.7.0 on <span class="colophon-date" title="Monday 2 December 2024 12:15">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR1113/gallery/helmholtz/index.html

@@ -108,4 +108,4 @@
 vtk = VTKGridFile("helmholtz", dh)
 write_solution(vtk, dh, u)
 close(vtk)
-println(&quot;Helmholtz successful&quot;)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Helmholtz successful</code></pre><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"><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.7.0 on <span class="colophon-date" title="Monday 2 December 2024 12:11">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+println(&quot;Helmholtz successful&quot;)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Helmholtz successful</code></pre><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"><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.7.0 on <span class="colophon-date" title="Monday 2 December 2024 12:15">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>