Skip to content

Commit

Permalink
build based on 019abc7
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 14, 2024
1 parent 5a5221e commit 71d4cc0
Show file tree
Hide file tree
Showing 10 changed files with 31 additions and 23 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-10-04T12:18:29","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-10-14T12:12:55","documenter_version":"1.7.0"}}
2 changes: 1 addition & 1 deletion dev/BNSPlots/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/Braedstrup/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
153.897 118.897 93.5639 74.8265 60.7942 -27.2873 -20.0578 -14.7582 -10.8234
144.883 112.083 87.7717 69.5736 55.8771 -29.8091 -21.8784 -16.1027 -11.856
136.767 108.025 86.4461 69.9911 57.3688 … -28.6089 -20.7213 -15.0661 -10.9335
149.022 124.549 105.729 90.6145 78.3994 -22.1191 -15.7456 -11.0385 -7.4812</code></pre><h2 id="Plots"><a class="docs-heading-anchor" href="#Plots">Plots</a><a id="Plots-1"></a><a class="docs-heading-anchor-permalink" href="#Plots" title="Permalink"></a></h2><p>In order to visualize the results, we can use the subpackage <code>BNSPlots</code>. For more details, refer to <code>[Visualizing the result with BNSPlots](@ref)</code>.</p><p>Inlet borehole temperatures and heat flows for boreholes along two branches in the borehole field. The time series are color coded according to the previous configuration plot above. In addition to the inlet temperature, the output temperature from the branch (grey dot), and the mean output temperature from the field (black dot) are displayed.</p><p><img src="../examples/Braedstrup/branch1.png" alt/> <img src="../examples/Braedstrup/branch2_test1.png" alt/></p><p>Finally we can display the heatmap of the temperature field in the borehole region during the 10th year of operation</p><p><img src="../examples/Braedstrup/heatmap_test1.png" alt/></p><h2 id="Running-the-code-in-Python"><a class="docs-heading-anchor" href="#Running-the-code-in-Python">Running the code in Python</a><a id="Running-the-code-in-Python-1"></a><a class="docs-heading-anchor-permalink" href="#Running-the-code-in-Python" title="Permalink"></a></h2><p>The example is also avaiable from Python. For details of how this is done refer to <a href="../python/#Running-BoreholeNetworksSimulator-from-Python">Running BoreholeNetworksSimulator from Python</a>. The Python version is in:</p><pre><code class="nohighlight hljs">examples/Braedstrup/main.py</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../BNSPlots/">« Visualizing the result with BNSPlots</a><a class="docs-footer-nextpage" href="../api/">API »</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="Friday 4 October 2024 12:18">Friday 4 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
149.022 124.549 105.729 90.6145 78.3994 -22.1191 -15.7456 -11.0385 -7.4812</code></pre><h2 id="Plots"><a class="docs-heading-anchor" href="#Plots">Plots</a><a id="Plots-1"></a><a class="docs-heading-anchor-permalink" href="#Plots" title="Permalink"></a></h2><p>In order to visualize the results, we can use the subpackage <code>BNSPlots</code>. For more details, refer to <code>[Visualizing the result with BNSPlots](@ref)</code>.</p><p>Inlet borehole temperatures and heat flows for boreholes along two branches in the borehole field. The time series are color coded according to the previous configuration plot above. In addition to the inlet temperature, the output temperature from the branch (grey dot), and the mean output temperature from the field (black dot) are displayed.</p><p><img src="../examples/Braedstrup/branch1.png" alt/> <img src="../examples/Braedstrup/branch2_test1.png" alt/></p><p>Finally we can display the heatmap of the temperature field in the borehole region during the 10th year of operation</p><p><img src="../examples/Braedstrup/heatmap_test1.png" alt/></p><h2 id="Running-the-code-in-Python"><a class="docs-heading-anchor" href="#Running-the-code-in-Python">Running the code in Python</a><a id="Running-the-code-in-Python-1"></a><a class="docs-heading-anchor-permalink" href="#Running-the-code-in-Python" title="Permalink"></a></h2><p>The example is also avaiable from Python. For details of how this is done refer to <a href="../python/#Running-BoreholeNetworksSimulator-from-Python">Running BoreholeNetworksSimulator from Python</a>. The Python version is in:</p><pre><code class="nohighlight hljs">examples/Braedstrup/main.py</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../BNSPlots/">« Visualizing the result with BNSPlots</a><a class="docs-footer-nextpage" href="../api/">API »</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 14 October 2024 12:12">Monday 14 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
24 changes: 14 additions & 10 deletions dev/api/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/index.html
View file

Large diffs are not rendered by default.

10 changes: 6 additions & 4 deletions dev/nonhistory/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
Δt = Δt,
Nt = Nt,
configurations = configurations
)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">SimulationOptions{Float64, NonHistoryMethod{Float64}, HeatLoadConstraint{Float64}, EqualBoreholesBorefield{SingleUPipeBorehole{Float64}, Float64}, GroundMedium{Float64}, DirichletBoundaryCondition, MeanApproximation, Water}
)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">SimulationOptions{Float64, Float64, NonHistoryMethod{Float64}, HeatLoadConstraint{Float64}, EqualBoreholesBorefield{SingleUPipeBorehole{Float64}, Float64}, GroundMedium{Float64}, DirichletBoundaryCondition, MeanApproximation, Water}
method: NonHistoryMethod{Float64}
constraint: HeatLoadConstraint{Float64}
borefield: EqualBoreholesBorefield{SingleUPipeBorehole{Float64}, Float64}
Expand All @@ -46,9 +46,11 @@
Tmax: Float64 3.1536e7
t: StepRangeLen{Float64, Base.TwicePrecision{Float64}, Base.TwicePrecision{Float64}, Int64}
configurations: Array{BoreholeNetwork}((1,))
atol: Float64 0.0
rtol: Float64 1.4901161193847656e-8
</code></pre><p>Let us run the convolution</p><pre><code class="language-julia hljs">containers_convolution = @time initialize(options_convolution)
@time simulate!(operator=operator, options=options_convolution, containers=containers_convolution)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi"> 6.779180 seconds (4.36 M allocations: 1.251 GiB, 1.74% gc time, 23.09% compilation time)
4.955480 seconds (7.08 M allocations: 434.665 MiB, 2.43% gc time, 79.97% compilation time)</code></pre><p>And now let us run the non-history</p><pre><code class="language-julia hljs">containers_nonhistory = @time initialize(options_nonhistory)
@time simulate!(operator=operator, options=options_convolution, containers=containers_convolution)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi"> 6.902249 seconds (4.47 M allocations: 1.252 GiB, 1.58% gc time, 23.06% compilation time)
4.864411 seconds (7.08 M allocations: 434.579 MiB, 1.75% gc time, 79.73% compilation time)</code></pre><p>And now let us run the non-history</p><pre><code class="language-julia hljs">containers_nonhistory = @time initialize(options_nonhistory)
@time simulate!(operator=operator, options=options_nonhistory, containers=containers_nonhistory)

abs.(containers_convolution.X - containers_nonhistory.X)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">8×8760 Matrix{Float64}:
Expand All @@ -59,4 +61,4 @@
5.05143e-11 4.84537e-11 5.72768e-11 1.17982e-10 1.17982e-10
5.05143e-11 4.84537e-11 5.72768e-11 … 1.17982e-10 1.17982e-10
0.0 0.0 0.0 0.0 0.0
0.0 0.0 0.0 0.0 0.0</code></pre><h2 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h2><p>[1] <a href="https://doi.org/10.22488/okstate.24.000021">Lazzarotto, Alberto; Basquens, Marc; Cimmino, Massimo; <em>Non-history dependent temporal superposition algorithm for the point source solution</em>, Research Conference Proceedings of the IGSHPA (2024).</a></p><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"><a class="docs-footer-prevpage" href="../tutorial/">« Basic tutorial</a><a class="docs-footer-nextpage" href="../python/">Running from python »</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="Friday 4 October 2024 12:18">Friday 4 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
0.0 0.0 0.0 0.0 0.0</code></pre><h2 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h2><p>[1] <a href="https://doi.org/10.22488/okstate.24.000021">Lazzarotto, Alberto; Basquens, Marc; Cimmino, Massimo; <em>Non-history dependent temporal superposition algorithm for the point source solution</em>, Research Conference Proceedings of the IGSHPA (2024).</a></p><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"><a class="docs-footer-prevpage" href="../tutorial/">« Basic tutorial</a><a class="docs-footer-nextpage" href="../python/">Running from python »</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 14 October 2024 12:12">Monday 14 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Binary file modified dev/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion dev/python/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@


operator = SimpleOperator(2., 2)</code></pre><p>Note that this is equivalent to calling the same code from Julia:</p><pre><code class="nohighlight hljs">operator = jl.SimpleOperator(mass_flow = 2., branches = 2)</code></pre><p>Finally we can run the simulation</p><pre><code class="nohighlight hljs">containers = jl.initialize(options)
jl.simulate_b(operator=operator, options=options, containers=containers)</code></pre><p>Note that the bang in <code>simulate!</code> is replaced by a <code>_b</code> in the juliacall version of the function. </p><pre><code class="nohighlight hljs">containers.X</code></pre><p>Now, one can compare this result with its Julia version. If everything went right, they should agree!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../nonhistory/">« Non-history method</a><a class="docs-footer-nextpage" href="../BNSPlots/">Visualizing the result with BNSPlots »</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="Friday 4 October 2024 12:18">Friday 4 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
jl.simulate_b(operator=operator, options=options, containers=containers)</code></pre><p>Note that the bang in <code>simulate!</code> is replaced by a <code>_b</code> in the juliacall version of the function. </p><pre><code class="nohighlight hljs">containers.X</code></pre><p>Now, one can compare this result with its Julia version. If everything went right, they should agree!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../nonhistory/">« Non-history method</a><a class="docs-footer-nextpage" href="../BNSPlots/">Visualizing the result with BNSPlots »</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 14 October 2024 12:12">Monday 14 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/search_index.js
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 71d4cc0

Please sign in to comment.