build based on 1bfe36b

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-28T14:02:00","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-12T14:31:27","documenter_version":"1.7.0"}}

dev/index.html

@@ -34,7 +34,7 @@
     :total_time => Float64
     :output_time => Float64
 
-  Completed at Oct. 28 2024 14:10 after 11 seconds, 560 milliseconds, 54.16 microseconds.</code></pre><h3 id="Visualizing-the-results"><a class="docs-heading-anchor" href="#Visualizing-the-results">Visualizing the results</a><a id="Visualizing-the-results-1"></a><a class="docs-heading-anchor-permalink" href="#Visualizing-the-results" title="Permalink"></a></h3><p>If using Julia 1.9 or later, visualization is provided if a version of Makie is included. In the documentation we use CairoMakie as it can produce plots on servers without rendering capabilities, such as the one where the Jutul continious integration is running:</p><pre><code class="language-julia hljs">using CairoMakie</code></pre><p>If you are running this locally and want interactive plots you can instead use the <code>GLMakie</code> backend.</p><pre><code class="language-julia hljs">using GLMakie
+  Completed at Nov. 12 2024 14:11 after 11 seconds, 337 milliseconds, 653.3 microseconds.</code></pre><h3 id="Visualizing-the-results"><a class="docs-heading-anchor" href="#Visualizing-the-results">Visualizing the results</a><a id="Visualizing-the-results-1"></a><a class="docs-heading-anchor-permalink" href="#Visualizing-the-results" title="Permalink"></a></h3><p>If using Julia 1.9 or later, visualization is provided if a version of Makie is included. In the documentation we use CairoMakie as it can produce plots on servers without rendering capabilities, such as the one where the Jutul continious integration is running:</p><pre><code class="language-julia hljs">using CairoMakie</code></pre><p>If you are running this locally and want interactive plots you can instead use the <code>GLMakie</code> backend.</p><pre><code class="language-julia hljs">using GLMakie
 GLMakie.activate!()</code></pre><p>We plot the initial conditions:</p><pre><code class="language-julia hljs">fig, ax = plot_cell_data(g, state0[:T])
 fig</code></pre><img src="index-29738f6e.png" alt="Example block output"/><p>We can then plot the final state, observing significant diffusion from the sharp initial state.</p><pre><code class="language-julia hljs">fig, ax = plot_cell_data(g, states[end][:T])
-fig</code></pre><img src="index-12cad33f.png" alt="Example block output"/><p>There is also interactive plotting that allows you to step through each time-step. This is most relevant when using <code>GLMakie</code> to plot, otherwise the figure will be static.</p><pre><code class="language-julia hljs">plot_interactive(g, [state0; states])</code></pre><img src="index-db3bda89.png" alt="Example block output"/><h2 id="Contents"><a class="docs-heading-anchor" href="#Contents">Contents</a><a id="Contents-1"></a><a class="docs-heading-anchor-permalink" href="#Contents" title="Permalink"></a></h2><ul><li><a href="docstrings/#Docstrings">Docstrings</a></li><li><a href="#Jutul-documentation">Jutul documentation</a></li><li class="no-marker"><ul><li><a href="#About">About</a></li><li><a href="#An-example">An example</a></li><li><a href="#Contents">Contents</a></li></ul></li><li><a href="internals/#Internal-docstrings">Internal docstrings</a></li><li class="no-marker"><ul><li><a href="internals/#Entities-and-variables">Entities and variables</a></li><li><a href="internals/#Equations">Equations</a></li><li><a href="internals/#Automatic-differentiation">Automatic differentiation</a></li><li><a href="internals/#Matrix">Matrix</a></li><li><a href="internals/#Various">Various</a></li></ul></li><li><a href="usage/#High-level-docstrings">High-level docstrings</a></li><li class="no-marker"><ul><li><a href="usage/#Setting-up-models">Setting up models</a></li><li><a href="usage/#Systems-and-domains">Systems and domains</a></li><li><a href="usage/#Grids/meshes-and-geometry">Grids/meshes and geometry</a></li><li><a href="usage/#Set-up-of-system">Set up of system</a></li><li><a href="usage/#Simulator-interfaces">Simulator interfaces</a></li><li><a href="usage/#Sensitivities,-adjoints-and-optimization">Sensitivities, adjoints and optimization</a></li><li><a href="usage/#Linear-solvers">Linear solvers</a></li><li><a href="usage/#Execution-contexts">Execution contexts</a></li></ul></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="usage/">Usage »</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.7.0 on <span class="colophon-date" title="Monday 28 October 2024 14:02">Monday 28 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+fig</code></pre><img src="index-12cad33f.png" alt="Example block output"/><p>There is also interactive plotting that allows you to step through each time-step. This is most relevant when using <code>GLMakie</code> to plot, otherwise the figure will be static.</p><pre><code class="language-julia hljs">plot_interactive(g, [state0; states])</code></pre><img src="index-db3bda89.png" alt="Example block output"/><h2 id="Contents"><a class="docs-heading-anchor" href="#Contents">Contents</a><a id="Contents-1"></a><a class="docs-heading-anchor-permalink" href="#Contents" title="Permalink"></a></h2><ul><li><a href="docstrings/#Docstrings">Docstrings</a></li><li><a href="#Jutul-documentation">Jutul documentation</a></li><li class="no-marker"><ul><li><a href="#About">About</a></li><li><a href="#An-example">An example</a></li><li><a href="#Contents">Contents</a></li></ul></li><li><a href="internals/#Internal-docstrings">Internal docstrings</a></li><li class="no-marker"><ul><li><a href="internals/#Entities-and-variables">Entities and variables</a></li><li><a href="internals/#Equations">Equations</a></li><li><a href="internals/#Automatic-differentiation">Automatic differentiation</a></li><li><a href="internals/#Matrix">Matrix</a></li><li><a href="internals/#Various">Various</a></li></ul></li><li><a href="usage/#High-level-docstrings">High-level docstrings</a></li><li class="no-marker"><ul><li><a href="usage/#Setting-up-models">Setting up models</a></li><li><a href="usage/#Systems-and-domains">Systems and domains</a></li><li><a href="usage/#Grids/meshes-and-geometry">Grids/meshes and geometry</a></li><li><a href="usage/#Set-up-of-system">Set up of system</a></li><li><a href="usage/#Simulator-interfaces">Simulator interfaces</a></li><li><a href="usage/#Sensitivities,-adjoints-and-optimization">Sensitivities, adjoints and optimization</a></li><li><a href="usage/#Linear-solvers">Linear solvers</a></li><li><a href="usage/#Execution-contexts">Execution contexts</a></li></ul></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="usage/">Usage »</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.7.0 on <span class="colophon-date" title="Tuesday 12 November 2024 14:31">Tuesday 12 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>