-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Oct 3, 2024
1 parent
b7b3ca0
commit 07cd72a
Showing
29 changed files
with
1,685 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| v0.1.10 | ||
| v0.1.11 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-10-03T13:05:02","documenter_version":"1.7.0"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Visualizing the result with BNSPlots · BoreholeNetworksSimulator.jl</title><meta name="title" content="Visualizing the result with BNSPlots · BoreholeNetworksSimulator.jl"/><meta property="og:title" content="Visualizing the result with BNSPlots · BoreholeNetworksSimulator.jl"/><meta property="twitter:title" content="Visualizing the result with BNSPlots · BoreholeNetworksSimulator.jl"/><meta name="description" content="Documentation for BoreholeNetworksSimulator.jl."/><meta property="og:description" content="Documentation for BoreholeNetworksSimulator.jl."/><meta property="twitter:description" content="Documentation for BoreholeNetworksSimulator.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">BoreholeNetworksSimulator.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Introduction</a></li><li><span class="tocitem">Tutorial</span><ul><li><a class="tocitem" href="../tutorial/">Basic tutorial</a></li><li><a class="tocitem" href="../nonhistory/">Non-history method</a></li><li><a class="tocitem" href="../python/">Running from python</a></li></ul></li><li class="is-active"><a class="tocitem" href>Visualizing the result with BNSPlots</a><ul class="internal"><li><a class="tocitem" href="#Reference"><span>Reference</span></a></li></ul></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../Braedstrup/">Braedstrup borefield</a></li></ul></li><li><a class="tocitem" href="../api/">API</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Visualizing the result with BNSPlots</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Visualizing the result with BNSPlots</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/marcbasquensmunoz/BoreholeNetworksSimulator.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/marcbasquensmunoz/BoreholeNetworksSimulator.jl/blob/main/docs/src/BNSPlots.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Visualizing-the-result-with-BNSPlots"><a class="docs-heading-anchor" href="#Visualizing-the-result-with-BNSPlots">Visualizing the result with BNSPlots</a><a id="Visualizing-the-result-with-BNSPlots-1"></a><a class="docs-heading-anchor-permalink" href="#Visualizing-the-result-with-BNSPlots" title="Permalink"></a></h1><p>The repository contains a subpackage called <code>BNSPlots</code> that contains useful convenience functions to easily display the results obtained from <code>BoreholeNetworksSimulator</code>.</p><h2 id="Reference"><a class="docs-heading-anchor" href="#Reference">Reference</a><a id="Reference-1"></a><a class="docs-heading-anchor-permalink" href="#Reference" title="Permalink"></a></h2><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="BNSPlots.plot_borefield" href="#BNSPlots.plot_borefield"><code>BNSPlots.plot_borefield</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">plot_borefield(network, positions; distinguished_branches = [], colors = [])</code></pre><p>Makes a plot of the borefield, showing the boreholes numbered and their connections.</p><p><strong>Arguments</strong></p><ul><li><code>network</code>: Network specifying the connections between boreholes.</li><li><code>positions</code>: The positions of each borehole.</li></ul><p><strong>Optional arguments</strong></p><ul><li><code>distinguished_branches</code>: Vector of <code>Int</code>. If specified, the branches corresponding to the given values will be highlighted with the colors of <code>colors</code>.</li><li><code>colors</code>: Vector of <code>Tuples</code> of <code>Color</code>. If specified, uses each pair of colors to define a color gradient to color each of the branches of <code>distinguished_branches</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/marcbasquensmunoz/BoreholeNetworksSimulator.jl/blob/6c2cf537d9e6aa75373bd203e10b80610be9996f/BNSPlots/src/borefield.jl#L4-L15">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="BNSPlots.monitor" href="#BNSPlots.monitor"><code>BNSPlots.monitor</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">monitor(containers, branch, t; steps = 1:length(t), display = [:Tfin, :Tfout, :Tb, :q], Δt = :year, color_pair = (colorant"navajowhite2", colorant"darkgreen")</code></pre><p>Creates a plot of the result of the simulation.</p><p><strong>Arguments</strong></p><ul><li><code>containers</code>: The containers (<code>SimulationContainers</code>) containing the result of the simulation through <code>simulate!</code>.</li><li><code>branch</code>: A vector containing the IDs of the boreholes whose data will be displayed. </li><li><code>t</code>: The times at which the data corresponds. It should normally be <code>options.t</code>.</li></ul><p><strong>Optional arguments</strong></p><ul><li><code>steps</code>: Index of the steps to display in the plot.</li><li><code>display</code>: A vector describing which plots that will be generated. If <code>:Tfin</code>, <code>:Tfout</code> or <code>:Tb</code> are specified, a temperature plot will be created showing the inlet fluid temperature, the outlet fluid temperature, and the borehole wall temperature, respectively. If <code>:q</code> is specified, a separate power plot will be created shwoing the heat extracted per meter.</li><li><code>Δt</code>: The scale of the x-axis in the plot. Possible options: <code>:year</code>, <code>:month</code>, <code>:hour</code>.</li><li><code>color_pair</code>: A pair of colors used as extrema to generate a range of colors for each borehole. </li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/marcbasquensmunoz/BoreholeNetworksSimulator.jl/blob/6c2cf537d9e6aa75373bd203e10b80610be9996f/BNSPlots/src/monitor.jl#L11-L26">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../python/">« Running from python</a><a class="docs-footer-nextpage" href="../Braedstrup/">Braedstrup borefield »</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:05">Thursday 3 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.