build based on 5a40304

byuflowlab · Nov 16, 2024 · 9ef78da · 9ef78da
1 parent 7c7a9e5
commit 9ef78da
Show file tree

Hide file tree

Showing 27 changed files with 316 additions and 298 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.6","generation_timestamp":"2024-11-09T15:40:35","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.10.6","generation_timestamp":"2024-11-16T15:07:32","documenter_version":"1.8.0"}}
diff --git a/dev/C4Blade/airfoil_types/CCBlade/index.html b/dev/C4Blade/airfoil_types/CCBlade/index.html
diff --git a/dev/C4Blade/airfoil_types/DFDC/index.html b/dev/C4Blade/airfoil_types/DFDC/index.html
diff --git a/dev/C4Blade/airfoil_types/actuator_disk/index.html b/dev/C4Blade/airfoil_types/actuator_disk/index.html
diff --git a/dev/C4Blade/airfoil_types/cascade/index.html b/dev/C4Blade/airfoil_types/cascade/index.html
diff --git a/dev/C4Blade/api/index.html b/dev/C4Blade/api/index.html
diff --git a/dev/C4Blade/corrections/index.html b/dev/C4Blade/corrections/index.html
diff --git a/dev/C4Blade/intro/index.html b/dev/C4Blade/intro/index.html
diff --git a/dev/DuctAPE/advanced_usage/manual_repaneling/index.html b/dev/DuctAPE/advanced_usage/manual_repaneling/index.html
diff --git a/dev/DuctAPE/advanced_usage/option/index.html b/dev/DuctAPE/advanced_usage/option/index.html
diff --git a/dev/DuctAPE/advanced_usage/outputs/index.html b/dev/DuctAPE/advanced_usage/outputs/index.html
diff --git a/dev/DuctAPE/advanced_usage/precompilation/index.html b/dev/DuctAPE/advanced_usage/precompilation/index.html
diff --git a/dev/DuctAPE/api/api_index/index.html b/dev/DuctAPE/api/api_index/index.html
diff --git a/dev/DuctAPE/api/private_api/index.html b/dev/DuctAPE/api/private_api/index.html
diff --git a/dev/DuctAPE/api/private_postprocess/index.html b/dev/DuctAPE/api/private_postprocess/index.html
diff --git a/dev/DuctAPE/api/private_prelims/index.html b/dev/DuctAPE/api/private_prelims/index.html
diff --git a/dev/DuctAPE/api/private_preprocess/index.html b/dev/DuctAPE/api/private_preprocess/index.html
diff --git a/dev/DuctAPE/api/private_process/index.html b/dev/DuctAPE/api/private_process/index.html
diff --git a/dev/DuctAPE/api/private_utilities/index.html b/dev/DuctAPE/api/private_utilities/index.html
diff --git a/dev/DuctAPE/api/public_api/index.html b/dev/DuctAPE/api/public_api/index.html
diff --git a/dev/DuctAPE/api/visualiztion_api/index.html b/dev/DuctAPE/api/visualiztion_api/index.html
@@ -14,4 +14,4 @@
     plot_streamlines=false,
     verbose=false,
     kwargs...,
-)</code></pre><p>Generate standard suite of plots or animations from input and output objects.</p><p><strong>Arguments:</strong></p><ul><li><code>::staticPlots (or ::animatedPlots)</code> :</li><li><code>Plots::</code> : the Plots package namespace</li><li><code>ins::NamedTuple</code> : returned inputs from <code>analyze</code> function</li><li><code>outs::Vector{NamedTuple}</code> : retured outputs from <code>analyze</code> function</li></ul><p><strong>Keyword Arguments:</strong></p><ul><li><code>save_path=&quot;&quot;</code> : custom save path</li><li><code>static_file_type=&quot;.pdf&quot;</code> : file type for static files (must be compatible with the desired backend)</li><li><code>suffix=nothing</code> : custom suffixes, if unused plots files will be numbered starting from 1.</li><li><code>plot_geometry=true</code> : flag to generate geometry plot</li><li><code>plot_panels=false</code> : flag to include markers indicating panel edges in geometry plot</li><li><code>plot_pressure=false</code> : flag to generate surface pressures plot</li><li><code>plot_velocity=false</code> : flag to generate surface velocities plot</li><li><code>plot_boundary_layer=false</code> : flag to generate boundary layer plot</li><li><code>plot_streamlines=false</code> : flag to generate streamlines plot</li><li><code>verbose=false</code> : print verbose statements</li><li><code>kwargs...</code> : arguments passed into the plot functions (Plots keyword arguments/defaults to be used in every plot)</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byuflowlab/DuctAPE.jl/blob/a5ff2ada026adb81962b884154d94aa7bd5f76ae/src/visualization/convenience_plots.jl#L7-L45">source</a></section></article></article><nav class="docs-footer"><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="Saturday 9 November 2024 15:40">Saturday 9 November 2024</span>. Using Julia version 1.10.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+)</code></pre><p>Generate standard suite of plots or animations from input and output objects.</p><p><strong>Arguments:</strong></p><ul><li><code>::staticPlots (or ::animatedPlots)</code> :</li><li><code>Plots::</code> : the Plots package namespace</li><li><code>ins::NamedTuple</code> : returned inputs from <code>analyze</code> function</li><li><code>outs::Vector{NamedTuple}</code> : retured outputs from <code>analyze</code> function</li></ul><p><strong>Keyword Arguments:</strong></p><ul><li><code>save_path=&quot;&quot;</code> : custom save path</li><li><code>static_file_type=&quot;.pdf&quot;</code> : file type for static files (must be compatible with the desired backend)</li><li><code>suffix=nothing</code> : custom suffixes, if unused plots files will be numbered starting from 1.</li><li><code>plot_geometry=true</code> : flag to generate geometry plot</li><li><code>plot_panels=false</code> : flag to include markers indicating panel edges in geometry plot</li><li><code>plot_pressure=false</code> : flag to generate surface pressures plot</li><li><code>plot_velocity=false</code> : flag to generate surface velocities plot</li><li><code>plot_boundary_layer=false</code> : flag to generate boundary layer plot</li><li><code>plot_streamlines=false</code> : flag to generate streamlines plot</li><li><code>verbose=false</code> : print verbose statements</li><li><code>kwargs...</code> : arguments passed into the plot functions (Plots keyword arguments/defaults to be used in every plot)</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byuflowlab/DuctAPE.jl/blob/5a40304ad115cb1c111a9086902507ad14d39900/src/visualization/convenience_plots.jl#L7-L45">source</a></section></article></article><nav class="docs-footer"><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.8.0 on <span class="colophon-date" title="Saturday 16 November 2024 15:07">Saturday 16 November 2024</span>. Using Julia version 1.10.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/dev/DuctAPE/theory/index.html b/dev/DuctAPE/theory/index.html
diff --git a/dev/DuctAPE/tutorial/index.html b/dev/DuctAPE/tutorial/index.html
diff --git a/dev/DuctAPE/visualization/index.html b/dev/DuctAPE/visualization/index.html
@@ -14,7 +14,7 @@
     plot_streamlines=false,
     verbose=false,
     kwargs...,
-)</code></pre><p>Generate standard suite of plots or animations from input and output objects.</p><p><strong>Arguments:</strong></p><ul><li><code>::staticPlots (or ::animatedPlots)</code> :</li><li><code>Plots::</code> : the Plots package namespace</li><li><code>ins::NamedTuple</code> : returned inputs from <code>analyze</code> function</li><li><code>outs::Vector{NamedTuple}</code> : retured outputs from <code>analyze</code> function</li></ul><p><strong>Keyword Arguments:</strong></p><ul><li><code>save_path=&quot;&quot;</code> : custom save path</li><li><code>static_file_type=&quot;.pdf&quot;</code> : file type for static files (must be compatible with the desired backend)</li><li><code>suffix=nothing</code> : custom suffixes, if unused plots files will be numbered starting from 1.</li><li><code>plot_geometry=true</code> : flag to generate geometry plot</li><li><code>plot_panels=false</code> : flag to include markers indicating panel edges in geometry plot</li><li><code>plot_pressure=false</code> : flag to generate surface pressures plot</li><li><code>plot_velocity=false</code> : flag to generate surface velocities plot</li><li><code>plot_boundary_layer=false</code> : flag to generate boundary layer plot</li><li><code>plot_streamlines=false</code> : flag to generate streamlines plot</li><li><code>verbose=false</code> : print verbose statements</li><li><code>kwargs...</code> : arguments passed into the plot functions (Plots keyword arguments/defaults to be used in every plot)</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byuflowlab/DuctAPE.jl/blob/a5ff2ada026adb81962b884154d94aa7bd5f76ae/src/visualization/convenience_plots.jl#L7-L45">source</a></section></article><p>The following generates animations across the given advance ratios.</p><div class="admonition is-warning"><header class="admonition-header">Plotting Streamlines</header><div class="admonition-body"><p>Currently, plotting streamlines, especially animations, takes an exceptionally long time.</p></div></div><pre><code class="language- hljs">using Plots
+)</code></pre><p>Generate standard suite of plots or animations from input and output objects.</p><p><strong>Arguments:</strong></p><ul><li><code>::staticPlots (or ::animatedPlots)</code> :</li><li><code>Plots::</code> : the Plots package namespace</li><li><code>ins::NamedTuple</code> : returned inputs from <code>analyze</code> function</li><li><code>outs::Vector{NamedTuple}</code> : retured outputs from <code>analyze</code> function</li></ul><p><strong>Keyword Arguments:</strong></p><ul><li><code>save_path=&quot;&quot;</code> : custom save path</li><li><code>static_file_type=&quot;.pdf&quot;</code> : file type for static files (must be compatible with the desired backend)</li><li><code>suffix=nothing</code> : custom suffixes, if unused plots files will be numbered starting from 1.</li><li><code>plot_geometry=true</code> : flag to generate geometry plot</li><li><code>plot_panels=false</code> : flag to include markers indicating panel edges in geometry plot</li><li><code>plot_pressure=false</code> : flag to generate surface pressures plot</li><li><code>plot_velocity=false</code> : flag to generate surface velocities plot</li><li><code>plot_boundary_layer=false</code> : flag to generate boundary layer plot</li><li><code>plot_streamlines=false</code> : flag to generate streamlines plot</li><li><code>verbose=false</code> : print verbose statements</li><li><code>kwargs...</code> : arguments passed into the plot functions (Plots keyword arguments/defaults to be used in every plot)</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byuflowlab/DuctAPE.jl/blob/5a40304ad115cb1c111a9086902507ad14d39900/src/visualization/convenience_plots.jl#L7-L45">source</a></section></article><p>The following generates animations across the given advance ratios.</p><div class="admonition is-warning"><header class="admonition-header">Plotting Streamlines</header><div class="admonition-body"><p>Currently, plotting streamlines, especially animations, takes an exceptionally long time.</p></div></div><pre><code class="language- hljs">using Plots
 
 # - Advance Ratio Range - #
 advance_ratios = range(0.1, 2.0; step=0.01)
@@ -63,4 +63,4 @@
         bl_ylim=(0.1, 0.25), # keyword argument to set ylim for boundary layer plots
     )...,
 )
-nothing # hide</code></pre><div class="admonition is-info"><header class="admonition-header">Custom Defaults</header><div class="admonition-body"><p>Additional arguments splatted into <code>generate_plots</code> are passed into <code>Plots.plot</code> directly as keyword arguments.  In this case, <code>custom_defaults</code> happens to be the defaults associated with the plot formatting used in these docs.  Any arguments passed in this way will override any options set in the plots recipes for all the plots.  In the plots shown here, we have overridden the color palatte, but nothing else.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Custom Sizes</header><div class="admonition-body"><p>For some reason, specifying figure size causes misalignment with pressure and velocity distributions and the underlayed geometry.</p></div></div><p><img src="../../assets/geometry.png" alt/> <img src="../../assets/surface_pressure.gif" alt/> <img src="../../assets/surface_velocity.gif" alt/> <img src="../../assets/boundary_layer.gif" alt/> <img src="../../assets/streamlines.gif" alt/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../advanced_usage/outputs/">« Outputs</a><a class="docs-footer-nextpage" href="../api/public_api/">Public API Reference »</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="Saturday 9 November 2024 15:40">Saturday 9 November 2024</span>. Using Julia version 1.10.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+nothing # hide</code></pre><div class="admonition is-info"><header class="admonition-header">Custom Defaults</header><div class="admonition-body"><p>Additional arguments splatted into <code>generate_plots</code> are passed into <code>Plots.plot</code> directly as keyword arguments.  In this case, <code>custom_defaults</code> happens to be the defaults associated with the plot formatting used in these docs.  Any arguments passed in this way will override any options set in the plots recipes for all the plots.  In the plots shown here, we have overridden the color palatte, but nothing else.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Custom Sizes</header><div class="admonition-body"><p>For some reason, specifying figure size causes misalignment with pressure and velocity distributions and the underlayed geometry.</p></div></div><p><img src="../../assets/geometry.png" alt/> <img src="../../assets/surface_pressure.gif" alt/> <img src="../../assets/surface_velocity.gif" alt/> <img src="../../assets/boundary_layer.gif" alt/> <img src="../../assets/streamlines.gif" alt/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../advanced_usage/outputs/">« Outputs</a><a class="docs-footer-nextpage" href="../api/public_api/">Public API Reference »</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.8.0 on <span class="colophon-date" title="Saturday 16 November 2024 15:07">Saturday 16 November 2024</span>. Using Julia version 1.10.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"documenter":{"julia_version":"1.10.6","generation_timestamp":"2024-11-09T15:40:35","documenter_version":"1.7.0"}}
		{"documenter":{"julia_version":"1.10.6","generation_timestamp":"2024-11-16T15:07:32","documenter_version":"1.8.0"}}