build based on 217b796

v1.3.0/index.html

@@ -33,4 +33,4 @@
 plot!(x->my_p1  +  my_p2 * x  +  my_p3 * x * log(x), color=:red, label="f(x)=$(output_round(my_p1))  +  $(output_round(my_p2)) * x  +  $(output_round(my_p3)) * x * log(x)")
 
 savefig("plot.pdf")
-</code></pre><h2 id="The-HighVoronoi-package-provides"><a class="docs-heading-anchor" href="#The-HighVoronoi-package-provides">The <code>HighVoronoi</code> package provides</a><a id="The-HighVoronoi-package-provides-1"></a><a class="docs-heading-anchor-permalink" href="#The-HighVoronoi-package-provides" title="Permalink"></a></h2><ul><li>a series of data sets that allow to set up a Voronoi mesh in arbitrary dimension on a convex domain with plane boundaries or even without boundaries.</li><li>works for nodes in general and non-general position. In particular, verices may be generated by more than <span>$d+1$</span> generating nodes.</li><li>2 different methods to calculate the volumes and interface areas of cells: An exact triangulation method and a Montecarlo method</li><li>3 different methods to integrate functions:<ul><li>two on the fly for both triangulation and Montecarlo</li><li>one heuristic method based on given volume and surface data</li></ul></li><li>Refinement of Voronoi tessellations: Add points to your grid and the algorithm will locally recalculate the mesh, including integration of volume, area and functions.</li><li>Fast calculation of periodic grids using the <code>periodic_grid</code> keyword.</li><li>Set up the linear equation for a finite volume Voronoi discretization of a given elliptic PDE with Neumann, Dirichlet or periodic boundary conditions</li><li>other functionalities like 2D data export in Metapost, storing and loading data.</li></ul><h2 id="Important-data-structures-and-methods"><a class="docs-heading-anchor" href="#Important-data-structures-and-methods">Important data structures and methods</a><a id="Important-data-structures-and-methods-1"></a><a class="docs-heading-anchor-permalink" href="#Important-data-structures-and-methods" title="Permalink"></a></h2><h3 id="Data-structures"><a class="docs-heading-anchor" href="#Data-structures">Data structures</a><a id="Data-structures-1"></a><a class="docs-heading-anchor-permalink" href="#Data-structures" title="Permalink"></a></h3><ul><li><code>VoronoiGeometry</code>: Creating, loading, updating, refining and managing the mesh</li><li><code>VoronoiNodes</code>: Nodes for mesh generation</li><li><code>Boundary</code>: Boundary of the mesh</li><li><code>VoronoiData</code>: Providing the data of the mesh for further use outside of <code>HighVoronoi.jl</code></li><li><code>VoronoiFVProblem</code>: Calculating internal data for setting up linear matrix equations for Finite Volume discretizations on a <code>VoronoiGeometry</code></li><li><code>StepFunction</code>: Generates a piecewise constant function</li><li><code>InterfaceFunction</code>: Generates a function living on interfaces.</li><li><code>FunctionComposer</code>: Glues together several functions and returns a new vector valued function.</li></ul><h3 id="Methods"><a class="docs-heading-anchor" href="#Methods">Methods</a><a id="Methods-1"></a><a class="docs-heading-anchor-permalink" href="#Methods" title="Permalink"></a></h3><ul><li><code>write_jld</code>: Store a <code>VoronoiGeometry</code></li><li><code>refine!</code>: refine a <code>VoronoiGeometry</code> by new nodes</li><li><code>substitute!</code>: refine a <code>VoronoiGeometry</code> by erasing the points in a given subdomain and replacing them by a finer precalculated grid. Automatically fills out all the gaps.</li><li><code>interactionmatrix</code>: constructs a projectoin from a function on one geometry to a function on a second geometry.</li><li><code>linearVoronoiFVProblem</code>: Extract the Matrix and right-hand-side from a given <code>VoronoiFVProblem</code> and for given boundary conditions.</li></ul><h3 id="To-be-implemented-in-a-forthcoming-version"><a class="docs-heading-anchor" href="#To-be-implemented-in-a-forthcoming-version">To be implemented in a forthcoming version</a><a id="To-be-implemented-in-a-forthcoming-version-1"></a><a class="docs-heading-anchor-permalink" href="#To-be-implemented-in-a-forthcoming-version" title="Permalink"></a></h3><ul><li>refine a <code>VoronoiFVProblem</code>. Project a given &quot;rough&quot; FV solution of a <code>linearVoronoiFVProblem</code> onto the refined solution space. </li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/short/">Examples Voronoi Generation »</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.24 on <span class="colophon-date" title="Thursday 12 September 2024 09:47">Thursday 12 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre><h2 id="The-HighVoronoi-package-provides"><a class="docs-heading-anchor" href="#The-HighVoronoi-package-provides">The <code>HighVoronoi</code> package provides</a><a id="The-HighVoronoi-package-provides-1"></a><a class="docs-heading-anchor-permalink" href="#The-HighVoronoi-package-provides" title="Permalink"></a></h2><ul><li>a series of data sets that allow to set up a Voronoi mesh in arbitrary dimension on a convex domain with plane boundaries or even without boundaries.</li><li>works for nodes in general and non-general position. In particular, verices may be generated by more than <span>$d+1$</span> generating nodes.</li><li>2 different methods to calculate the volumes and interface areas of cells: An exact triangulation method and a Montecarlo method</li><li>3 different methods to integrate functions:<ul><li>two on the fly for both triangulation and Montecarlo</li><li>one heuristic method based on given volume and surface data</li></ul></li><li>Refinement of Voronoi tessellations: Add points to your grid and the algorithm will locally recalculate the mesh, including integration of volume, area and functions.</li><li>Fast calculation of periodic grids using the <code>periodic_grid</code> keyword.</li><li>Set up the linear equation for a finite volume Voronoi discretization of a given elliptic PDE with Neumann, Dirichlet or periodic boundary conditions</li><li>other functionalities like 2D data export in Metapost, storing and loading data.</li></ul><h2 id="Important-data-structures-and-methods"><a class="docs-heading-anchor" href="#Important-data-structures-and-methods">Important data structures and methods</a><a id="Important-data-structures-and-methods-1"></a><a class="docs-heading-anchor-permalink" href="#Important-data-structures-and-methods" title="Permalink"></a></h2><h3 id="Data-structures"><a class="docs-heading-anchor" href="#Data-structures">Data structures</a><a id="Data-structures-1"></a><a class="docs-heading-anchor-permalink" href="#Data-structures" title="Permalink"></a></h3><ul><li><code>VoronoiGeometry</code>: Creating, loading, updating, refining and managing the mesh</li><li><code>VoronoiNodes</code>: Nodes for mesh generation</li><li><code>Boundary</code>: Boundary of the mesh</li><li><code>VoronoiData</code>: Providing the data of the mesh for further use outside of <code>HighVoronoi.jl</code></li><li><code>VoronoiFVProblem</code>: Calculating internal data for setting up linear matrix equations for Finite Volume discretizations on a <code>VoronoiGeometry</code></li><li><code>StepFunction</code>: Generates a piecewise constant function</li><li><code>InterfaceFunction</code>: Generates a function living on interfaces.</li><li><code>FunctionComposer</code>: Glues together several functions and returns a new vector valued function.</li></ul><h3 id="Methods"><a class="docs-heading-anchor" href="#Methods">Methods</a><a id="Methods-1"></a><a class="docs-heading-anchor-permalink" href="#Methods" title="Permalink"></a></h3><ul><li><code>write_jld</code>: Store a <code>VoronoiGeometry</code></li><li><code>refine!</code>: refine a <code>VoronoiGeometry</code> by new nodes</li><li><code>substitute!</code>: refine a <code>VoronoiGeometry</code> by erasing the points in a given subdomain and replacing them by a finer precalculated grid. Automatically fills out all the gaps.</li><li><code>interactionmatrix</code>: constructs a projectoin from a function on one geometry to a function on a second geometry.</li><li><code>linearVoronoiFVProblem</code>: Extract the Matrix and right-hand-side from a given <code>VoronoiFVProblem</code> and for given boundary conditions.</li></ul><h3 id="To-be-implemented-in-a-forthcoming-version"><a class="docs-heading-anchor" href="#To-be-implemented-in-a-forthcoming-version">To be implemented in a forthcoming version</a><a id="To-be-implemented-in-a-forthcoming-version-1"></a><a class="docs-heading-anchor-permalink" href="#To-be-implemented-in-a-forthcoming-version" title="Permalink"></a></h3><ul><li>refine a <code>VoronoiFVProblem</code>. Project a given &quot;rough&quot; FV solution of a <code>linearVoronoiFVProblem</code> onto the refined solution space. </li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/short/">Examples Voronoi Generation »</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.24 on <span class="colophon-date" title="Thursday 12 September 2024 10:07">Thursday 12 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>