build based on 1ca7fff

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-20T08:11:11","documenter_version":"1.3.0"}}
+{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-20T12:15:01","documenter_version":"1.3.0"}}

dev/contributing/index.html

@@ -35,4 +35,4 @@
     are public and that a record of the contribution (including all
     personal information I submit with it, including my sign-off) is
     maintained indefinitely and may be redistributed consistent with
-    this project or the open source license(s) involved.</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../authors/">« Authors</a><a class="docs-footer-nextpage" href="../code_of_conduct/">Code of Conduct »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Wednesday 20 March 2024 08:11">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+    this project or the open source license(s) involved.</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../authors/">« Authors</a><a class="docs-footer-nextpage" href="../code_of_conduct/">Code of Conduct »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Wednesday 20 March 2024 12:15">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/general/neighborhood_search/index.html

@@ -5,8 +5,8 @@
                           neighborhood_search=GridNeighborhoodSearch)</code></pre><p>The keyword arguments <code>periodic_box_min_corner</code> and <code>periodic_box_max_corner</code> explained above can also be passed to the <a href="../semidiscretization/#Semidiscretization"><code>Semidiscretization</code></a> and will internally be forwarded to the neighborhood search:</p><pre><code class="language-julia hljs">semi = Semidiscretization(system1, system2,
                           neighborhood_search=GridNeighborhoodSearch,
                           periodic_box_min_corner=[0.0, -0.25],
-                          periodic_box_max_corner=[1.0, 0.75])</code></pre></div></div><p><strong>References</strong></p><ul><li>M. Chalela, E. Sillero, L. Pereyra, M.A. Garcia, J.B. Cabral, M. Lares, M. Merchán. &quot;GriSPy: A Python package for fixed-radius nearest neighbors search&quot;. In: Astronomy and Computing 34 (2021). <a href="https://doi.org/10.1016/j.ascom.2020.100443">doi: 10.1016/j.ascom.2020.100443</a></li><li>Markus Ihmsen, Nadir Akinci, Markus Becker, Matthias Teschner. &quot;A Parallel SPH Implementation on Multi-Core CPUs&quot;. In: Computer Graphics Forum 30.1 (2011), pages 99–112. <a href="https://doi.org/10.1111/J.1467-8659.2010.01832.X">doi: 10.1111/J.1467-8659.2010.01832.X</a></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/trixi-framework/TrixiParticles.jl/blob/fe2a6cc12905fa3db1376e37e829f440c6b9374a/src/neighborhood_search/grid_nhs.jl#L1-L91">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="TrixiParticles.TrivialNeighborhoodSearch" href="#TrixiParticles.TrivialNeighborhoodSearch"><code>TrixiParticles.TrivialNeighborhoodSearch</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">TrivialNeighborhoodSearch{NDIMS}(search_radius, eachparticle)</code></pre><p>Trivial neighborhood search that simply loops over all particles. The search radius still needs to be passed in order to sort out particles outside the search radius in the internal function <code>for_particle_neighbor</code>, but it&#39;s not used in the internal function <code>eachneighbor</code>.</p><p><strong>Arguments</strong></p><ul><li><code>NDIMS</code>:          Number of dimensions.</li><li><code>search_radius</code>:  The uniform search radius.</li><li><code>eachparticle</code>:   <code>UnitRange</code> of all particle indices. Usually just <code>1:n_particles</code>.</li></ul><p><strong>Keywords</strong></p><ul><li><code>periodic_box_min_corner</code>:    In order to use a (rectangular) periodic domain, pass the                               coordinates of the domain corner in negative coordinate                               directions.</li><li><code>periodic_box_max_corner</code>:    In order to use a (rectangular) periodic domain, pass the                               coordinates of the domain corner in positive coordinate                               directions.</li></ul><div class="admonition is-warning"><header class="admonition-header">Internal use only</header><div class="admonition-body"><p>Please note that this constructor is intended for internal use only. It is <em>not</em> part of the public API of TrixiParticles.jl, and it thus can altered (or be removed) at any time without it being considered a breaking change.</p><p>To run a simulation with this neighborhood search, just pass the type to the constructor of <a href="../semidiscretization/#Semidiscretization"><code>Semidiscretization</code></a>:</p><pre><code class="language-julia hljs">semi = Semidiscretization(system1, system2,
+                          periodic_box_max_corner=[1.0, 0.75])</code></pre></div></div><p><strong>References</strong></p><ul><li>M. Chalela, E. Sillero, L. Pereyra, M.A. Garcia, J.B. Cabral, M. Lares, M. Merchán. &quot;GriSPy: A Python package for fixed-radius nearest neighbors search&quot;. In: Astronomy and Computing 34 (2021). <a href="https://doi.org/10.1016/j.ascom.2020.100443">doi: 10.1016/j.ascom.2020.100443</a></li><li>Markus Ihmsen, Nadir Akinci, Markus Becker, Matthias Teschner. &quot;A Parallel SPH Implementation on Multi-Core CPUs&quot;. In: Computer Graphics Forum 30.1 (2011), pages 99–112. <a href="https://doi.org/10.1111/J.1467-8659.2010.01832.X">doi: 10.1111/J.1467-8659.2010.01832.X</a></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/trixi-framework/TrixiParticles.jl/blob/1ca7fffaa9aee4d3f51bc54dc713b5754c1f6966/src/neighborhood_search/grid_nhs.jl#L1-L91">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="TrixiParticles.TrivialNeighborhoodSearch" href="#TrixiParticles.TrivialNeighborhoodSearch"><code>TrixiParticles.TrivialNeighborhoodSearch</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">TrivialNeighborhoodSearch{NDIMS}(search_radius, eachparticle)</code></pre><p>Trivial neighborhood search that simply loops over all particles. The search radius still needs to be passed in order to sort out particles outside the search radius in the internal function <code>for_particle_neighbor</code>, but it&#39;s not used in the internal function <code>eachneighbor</code>.</p><p><strong>Arguments</strong></p><ul><li><code>NDIMS</code>:          Number of dimensions.</li><li><code>search_radius</code>:  The uniform search radius.</li><li><code>eachparticle</code>:   <code>UnitRange</code> of all particle indices. Usually just <code>1:n_particles</code>.</li></ul><p><strong>Keywords</strong></p><ul><li><code>periodic_box_min_corner</code>:    In order to use a (rectangular) periodic domain, pass the                               coordinates of the domain corner in negative coordinate                               directions.</li><li><code>periodic_box_max_corner</code>:    In order to use a (rectangular) periodic domain, pass the                               coordinates of the domain corner in positive coordinate                               directions.</li></ul><div class="admonition is-warning"><header class="admonition-header">Internal use only</header><div class="admonition-body"><p>Please note that this constructor is intended for internal use only. It is <em>not</em> part of the public API of TrixiParticles.jl, and it thus can altered (or be removed) at any time without it being considered a breaking change.</p><p>To run a simulation with this neighborhood search, just pass the type to the constructor of <a href="../semidiscretization/#Semidiscretization"><code>Semidiscretization</code></a>:</p><pre><code class="language-julia hljs">semi = Semidiscretization(system1, system2,
                           neighborhood_search=TrivialNeighborhoodSearch)</code></pre><p>The keyword arguments <code>periodic_box_min_corner</code> and <code>periodic_box_max_corner</code> explained above can also be passed to the <a href="../semidiscretization/#Semidiscretization"><code>Semidiscretization</code></a> and will internally be forwarded to the neighborhood search:</p><pre><code class="language-julia hljs">semi = Semidiscretization(system1, system2,
                           neighborhood_search=TrivialNeighborhoodSearch,
                           periodic_box_min_corner=[0.0, -0.25],
-                          periodic_box_max_corner=[1.0, 0.75])</code></pre></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/trixi-framework/TrixiParticles.jl/blob/fe2a6cc12905fa3db1376e37e829f440c6b9374a/src/neighborhood_search/trivial_nhs.jl#L1-L62">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../smoothing_kernels/">« Smoothing Kernels</a><a class="docs-footer-nextpage" href="../util/">Util »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Wednesday 20 March 2024 08:11">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+                          periodic_box_max_corner=[1.0, 0.75])</code></pre></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/trixi-framework/TrixiParticles.jl/blob/1ca7fffaa9aee4d3f51bc54dc713b5754c1f6966/src/neighborhood_search/trivial_nhs.jl#L1-L62">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../smoothing_kernels/">« Smoothing Kernels</a><a class="docs-footer-nextpage" href="../util/">Util »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Wednesday 20 March 2024 12:15">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>