Skip to content

Commit

Permalink
build based on b761121
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 3, 2024
1 parent 07cd72a commit a7918c3
Show file tree
Hide file tree
Showing 11 changed files with 28 additions and 26 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-03T13:04:40","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-10-03T13:58:43","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="Thursday 3 October 2024 13:04">Thursday 3 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="Thursday 3 October 2024 13:58">Thursday 3 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
20 changes: 10 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.

5 changes: 3 additions & 2 deletions dev/nonhistory.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ borehole = SingleUPipeBorehole(H=100., D=10.)
positions = [(0., 0.), (0., 5.)]
borefield = EqualBoreholesBorefield(borehole_prototype=borehole, positions=positions)
constraint = constant_HeatLoadConstraint(5 .* ones(BoreholeNetworksSimulator.n_boreholes(borefield)), Nt)
fluid = Water()

configurations = [BoreholeNetwork([[1], [2]])]
operator = SimpleOperator(mass_flow = 2., branches = 2)
Expand All @@ -34,7 +35,7 @@ options_convolution = SimulationOptions(
constraint = constraint,
borefield = borefield,
medium = medium,
fluid = Water(),
fluid = fluid,
Δt = Δt,
Nt = Nt,
configurations = configurations
Expand All @@ -45,7 +46,7 @@ options_nonhistory = SimulationOptions(
constraint = constraint,
borefield = borefield,
medium = medium,
fluid = Water(),
fluid = fluid,
Δt = Δt,
Nt = Nt,
configurations = configurations
Expand Down
11 changes: 6 additions & 5 deletions dev/nonhistory/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@
positions = [(0., 0.), (0., 5.)]
borefield = EqualBoreholesBorefield(borehole_prototype=borehole, positions=positions)
constraint = constant_HeatLoadConstraint(5 .* ones(BoreholeNetworksSimulator.n_boreholes(borefield)), Nt)
fluid = Water()

configurations = [BoreholeNetwork([[1], [2]])]
operator = SimpleOperator(mass_flow = 2., branches = 2)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">SimpleOperator{Float64}([2.0, 2.0])</code></pre><p>Now, we define two different options using different <code>method</code> parameters, one with <code>ConvolutionMethod</code> corresponding to the convolution, and the other with <code>NonHistoryMethod</code>, corresponding with the non-history method.</p><pre><code class="language-julia hljs">options_convolution = SimulationOptions(
method = ConvolutionMethod(),
constraint = constraint,
borefield = borefield,
medium = medium,
fluid = Water(),
fluid = fluid,
Δt = Δt,
Nt = Nt,
configurations = configurations
Expand All @@ -25,7 +26,7 @@
constraint = constraint,
borefield = borefield,
medium = medium,
fluid = Water(),
fluid = fluid,
Δt = Δt,
Nt = Nt,
configurations = configurations
Expand All @@ -46,8 +47,8 @@
t: StepRangeLen{Float64, Base.TwicePrecision{Float64}, Base.TwicePrecision{Float64}, Int64}
configurations: Array{BoreholeNetwork}((1,))
</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"> 7.042296 seconds (4.36 M allocations: 1.251 GiB, 1.58% gc time, 22.05% compilation time)
4.999296 seconds (7.08 M allocations: 434.689 MiB, 1.54% gc time, 80.08% 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.995820 seconds (4.36 M allocations: 1.251 GiB, 1.82% gc time, 23.32% compilation time)
5.103590 seconds (7.08 M allocations: 434.707 MiB, 2.18% gc time, 79.71% 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 @@ -58,4 +59,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="Thursday 3 October 2024 13:04">Thursday 3 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="Thursday 3 October 2024 13:58">Thursday 3 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/objects.inv
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sphinx inventory version 2
# Project: BoreholeNetworksSimulator.jl
# Version: 0.1.11
# Version: 0.1.12
# The remainder of this file is compressed using zlib.
x��VMS�0��W��r�7R�2S�Ch{d{��ʒ�����W�-$6ĦbK�Vow�A�� Q:9MDL� ! ��HL�Q�@-$F���k32���{�OQٗmެ�ȭ��C2ЩH�|kx�P��Ƚ��YK�U���v2�U��f�*1��X:"A��uZ���� QZ���^����JHX#�$�rl��댜���� ��P�Ģ��k�Dhp ���qA�͹=& �O"��_O���a��W�AV�ۏ[)L��7B�RK� �l��iOæDu��H6�/�`���aU@/�pJԖ��K�廂��T\T���Y1��-Jo�r���`���;R9U�VOz���{@#,�(S;�M�tկ@�n���Y?ч��T_U'c,��{K��&�s�X��Y3q\�L�̏f�mi)r=P�+��e�t$5${���I��C;U�k�r����Kfp��ZRXZuB;��{ǃ �>q��Ȅy�ݻg� "%l$j���N��M���'�u��5�x
i(Aˊiiů�W�q?`til�\��m�MO�*�&4)ѵ�g��K򙝮/�?d���'��U�o��fl4�́���~�s�� ����pGŹ�bY��K�+!G�wvƑˑ�m��Ż�i����q<�d=o���5{�$�8��2{\p�P��-�������:k��ܥ�#�C�a�M�!��D�t/p8?v�����@�n㜤c$S���ol秵Α}w��f�C!�Q��0�Wm�`�ﴮ+��S������ >�5�۴��'oN�o��)�g��V�?�����M�Lλ�w���7��
Expand Down
Loading

0 comments on commit a7918c3

Please sign in to comment.