Skip to content

Commit

Permalink
build based on 158151a
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 14, 2024
1 parent 3e8b1ba commit 4c0a89c
Show file tree
Hide file tree
Showing 24 changed files with 702 additions and 714 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-14T12:23:10","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-10-14T13:13:03","documenter_version":"1.7.0"}}
14 changes: 7 additions & 7 deletions dev/contributor_guide/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/examples/01_2d-isothermal-backward-facing-step/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@
initialise!(model.momentum.U, velocity)
initialise!(model.momentum.p, 0.0)

residuals = run!(model, config);</code></pre><h1 id="Results"><a class="docs-heading-anchor" href="#Results">Results</a><a id="Results-1"></a><a class="docs-heading-anchor-permalink" href="#Results" title="Permalink"></a></h1><hr/><h2 id="Domain-and-mesh"><a class="docs-heading-anchor" href="#Domain-and-mesh">Domain and mesh</a><a id="Domain-and-mesh-1"></a><a class="docs-heading-anchor-permalink" href="#Domain-and-mesh" title="Permalink"></a></h2><p><img src="../figures/01/domain_mesh.png" alt="Simulation domain"/></p><h2 id="OpenFoam-solution"><a class="docs-heading-anchor" href="#OpenFoam-solution">OpenFoam solution</a><a id="OpenFoam-solution-1"></a><a class="docs-heading-anchor-permalink" href="#OpenFoam-solution" title="Permalink"></a></h2><p><img src="../figures/01/BFS_OpenFOAM.png" alt="Simulation domain"/></p><h2 id="XCALibre-solution"><a class="docs-heading-anchor" href="#XCALibre-solution">XCALibre solution</a><a id="XCALibre-solution-1"></a><a class="docs-heading-anchor-permalink" href="#XCALibre-solution" title="Permalink"></a></h2><p><img src="../figures/01/BFS_XCALibre.png" alt="Simulation domain"/></p><h2 id="Quantitative-comparision"><a class="docs-heading-anchor" href="#Quantitative-comparision">Quantitative comparision</a><a id="Quantitative-comparision-1"></a><a class="docs-heading-anchor-permalink" href="#Quantitative-comparision" title="Permalink"></a></h2><p>The figure below compares the results obtained with OpenFOAM and XCALibre.jl. The profiles are extracted along the y-direction at x = 0.5 m. <img src="../figures/01/BFS_verification.svg" alt="Comparison with OpenFOAM"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../quick_start/">« Quick Start</a><a class="docs-footer-nextpage" href="../02_2d-incompressible-transient-cylinder/">Verification: 2D Unsteady incompressible cylinder »</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:23">Monday 14 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
residuals = run!(model, config);</code></pre><h1 id="Results"><a class="docs-heading-anchor" href="#Results">Results</a><a id="Results-1"></a><a class="docs-heading-anchor-permalink" href="#Results" title="Permalink"></a></h1><hr/><h2 id="Domain-and-mesh"><a class="docs-heading-anchor" href="#Domain-and-mesh">Domain and mesh</a><a id="Domain-and-mesh-1"></a><a class="docs-heading-anchor-permalink" href="#Domain-and-mesh" title="Permalink"></a></h2><p><img src="../figures/01/domain_mesh.png" alt="Simulation domain"/></p><h2 id="OpenFoam-solution"><a class="docs-heading-anchor" href="#OpenFoam-solution">OpenFoam solution</a><a id="OpenFoam-solution-1"></a><a class="docs-heading-anchor-permalink" href="#OpenFoam-solution" title="Permalink"></a></h2><p><img src="../figures/01/BFS_OpenFOAM.png" alt="Simulation domain"/></p><h2 id="XCALibre-solution"><a class="docs-heading-anchor" href="#XCALibre-solution">XCALibre solution</a><a id="XCALibre-solution-1"></a><a class="docs-heading-anchor-permalink" href="#XCALibre-solution" title="Permalink"></a></h2><p><img src="../figures/01/BFS_XCALibre.png" alt="Simulation domain"/></p><h2 id="Quantitative-comparision"><a class="docs-heading-anchor" href="#Quantitative-comparision">Quantitative comparision</a><a id="Quantitative-comparision-1"></a><a class="docs-heading-anchor-permalink" href="#Quantitative-comparision" title="Permalink"></a></h2><p>The figure below compares the results obtained with OpenFOAM and XCALibre.jl. The profiles are extracted along the y-direction at x = 0.5 m. <img src="../figures/01/BFS_verification.svg" alt="Comparison with OpenFOAM"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../quick_start/">« Quick Start</a><a class="docs-footer-nextpage" href="../02_2d-incompressible-transient-cylinder/">Verification: 2D Unsteady incompressible cylinder »</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 13:13">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/examples/02_2d-incompressible-transient-cylinder/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@
initialise!(model.momentum.U, velocity)
initialise!(model.momentum.p, 0.0)

residuals = run!(model, config)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../01_2d-isothermal-backward-facing-step/">« Verification: 2D incompressible backward-facing step</a><a class="docs-footer-nextpage" href="../03_2d-constant-temperature-flat-plate/">Validation: 2D Constant temperature flat plate »</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:23">Monday 14 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
residuals = run!(model, config)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../01_2d-isothermal-backward-facing-step/">« Verification: 2D incompressible backward-facing step</a><a class="docs-footer-nextpage" href="../03_2d-constant-temperature-flat-plate/">Validation: 2D Constant temperature flat plate »</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 13:13">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/examples/03_2d-constant-temperature-flat-plate/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,4 @@
initialise!(model.momentum.p, 100000.0)
initialise!(model.energy.T, 300.0)

residuals = run!(model, config)</code></pre><h1 id="Results"><a class="docs-heading-anchor" href="#Results">Results</a><a id="Results-1"></a><a class="docs-heading-anchor-permalink" href="#Results" title="Permalink"></a></h1><hr/><p>The results of the model are compared to the theoretical correlation in the figure below:</p><p><img src="../figures/03/Nusselt_const_temp_lam_plate.png" alt="Nusselt number distribution results."/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../02_2d-incompressible-transient-cylinder/">« Verification: 2D Unsteady incompressible cylinder</a><a class="docs-footer-nextpage" href="../04_2d-inflow-using-Flux/">Advanced: 2D inflow using <code>Flux.jl</code> »</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:23">Monday 14 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
residuals = run!(model, config)</code></pre><h1 id="Results"><a class="docs-heading-anchor" href="#Results">Results</a><a id="Results-1"></a><a class="docs-heading-anchor-permalink" href="#Results" title="Permalink"></a></h1><hr/><p>The results of the model are compared to the theoretical correlation in the figure below:</p><p><img src="../figures/03/Nusselt_const_temp_lam_plate.png" alt="Nusselt number distribution results."/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../02_2d-incompressible-transient-cylinder/">« Verification: 2D Unsteady incompressible cylinder</a><a class="docs-footer-nextpage" href="../04_2d-inflow-using-Flux/">Advanced: 2D inflow using <code>Flux.jl</code> »</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 13:13">Monday 14 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 4c0a89c

Please sign in to comment.