Deployed 9790a78 with MkDocs version: 1.1.2

byuflowlab · Nov 16, 2023 · 16b8d2b · 16b8d2b
1 parent a3903c3
commit 16b8d2b
Show file tree

Hide file tree

Showing 51 changed files with 206 additions and 108 deletions.
diff --git a/api/flowunsteady-maneuver/index.html b/api/flowunsteady-maneuver/index.html
diff --git a/api/flowunsteady-monitor/index.html b/api/flowunsteady-monitor/index.html
diff --git a/api/flowunsteady-openvsp/index.html b/api/flowunsteady-openvsp/index.html
@@ -0,0 +1,7 @@
+<!DOCTYPE html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Importing OpenVSP geometry · FLOWUnsteady</title><script async src="https://www.googletagmanager.com/gtag/js?id=G-B7CBF7WC7L"></script><script>  window.dataLayer = window.dataLayer || [];
+  function gtag(){dataLayer.push(arguments);}
+  gtag('js', new Date());
+  gtag('config', 'G-B7CBF7WC7L', {'page_path': location.pathname + location.search + location.hash});
+</script><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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="../../siteinfo.js"></script><script src="../../../versions.js"></script><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><link href="../../assets/favicon.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../../assets/logo.png" alt="FLOWUnsteady logo"/></a><form class="docs-search" action="../../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../../">Intro</a></li><li><a class="tocitem" href="../../installation/general/">Installation</a></li><li><input class="collapse-toggle" id="menuitem-4" type="checkbox"/><label class="tocitem" for="menuitem-4"><span class="docs-label">Tutorials</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><input class="collapse-toggle" id="menuitem-4-1" type="checkbox"/><label class="tocitem" for="menuitem-4-1"><span class="docs-label">Simple Wing</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../examples/wing-4p2aoa/">Basics</a></li><li><a class="tocitem" href="../../examples/wing-aoasweep/">AOA Sweep</a></li></ul></li><li><a class="tocitem" href="../../examples/tetheredwing/">Tethered Wing</a></li><li><a class="tocitem" href="../../examples/heavingwing/">Heaving Wing</a></li><li><input class="collapse-toggle" id="menuitem-4-4" type="checkbox"/><label class="tocitem" for="menuitem-4-4"><span class="docs-label">Propeller</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../examples/propeller-J040/">Basics</a></li><li><a class="tocitem" href="../../examples/propeller-jsweep/"><span>$J$</span> Sweep</a></li><li><a class="tocitem" href="../../examples/propeller-quasisteady/">Quasi-Steady Solver</a></li><li><a class="tocitem" href="../../examples/propeller-incidence/">Incidence Sweep</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-4-5" type="checkbox"/><label class="tocitem" for="menuitem-4-5"><span class="docs-label">Rotor in Hover</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../examples/rotorhover-aero/">Variable Fidelity</a></li><li><a class="tocitem" href="../../examples/rotorhover-fdom/">Fluid Domain</a></li><li><a class="tocitem" href="../../examples/rotorhover-acoustics/">Aeroacoustics</a></li><li><a class="tocitem" href="../../examples/rotorhover-quasisteady/">Quasi-Steady Solver</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-4-6" type="checkbox"/><label class="tocitem" for="menuitem-4-6"><span class="docs-label">Blown Wing</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../examples/blownwing-aero/">Aerodynamic Solution</a></li><li><a class="tocitem" href="../../examples/blownwing-asm/">Actuator Surface Model</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-4-7" type="checkbox"/><label class="tocitem" for="menuitem-4-7"><span class="docs-label">eVTOL Aircraft</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../examples/vahana-vehicle/">Vehicle Definition</a></li><li><a class="tocitem" href="../../examples/vahana-maneuver/">Maneuver Definition</a></li><li><a class="tocitem" href="../../examples/vahana-monitor/">Monitors Definitions</a></li><li><a class="tocitem" href="../../examples/vahana-run/">Run Simulation</a></li></ul></li><li><a class="tocitem" href="../../examples/openvsp-aircraft/">OpenVSP Geometry</a></li></ul></li><li><a class="tocitem" href="../../visualization/">Visualization</a></li><li><input class="collapse-toggle" id="menuitem-6" type="checkbox"/><label class="tocitem" for="menuitem-6"><span class="docs-label">Theory</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../theory/rvpm/">Reformulated VPM</a></li><li><a class="tocitem" href="../../theory/convergence/">Convergence</a></li><li><a class="tocitem" href="../../theory/validation/">Validation</a></li><li><a class="tocitem" href="../../theory/publications/">Publications</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-7" type="checkbox" checked/><label class="tocitem" for="menuitem-7"><span class="docs-label">API Guide</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><input class="collapse-toggle" id="menuitem-7-1" type="checkbox" checked/><label class="tocitem" for="menuitem-7-1"><span class="docs-label">(1) Vehicle Definition</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../flowunsteady-vehicle-types/">Vehicle types</a></li><li><a class="tocitem" href="../flowunsteady-vehicle-components/">Generating components</a></li><li><a class="tocitem" href="../flowunsteady-vehicle-asm/">Actuator surface model</a></li><li class="is-active"><a class="tocitem" href>Importing OpenVSP geometry</a></li></ul></li><li><a class="tocitem" href="../flowunsteady-maneuver/">(2) Maneuver Definition</a></li><li><a class="tocitem" href="../flowunsteady-simulation/">(3) Simulation Definition</a></li><li><a class="tocitem" href="../flowunsteady-monitor/">(4) Monitors Definitions</a></li><li><a class="tocitem" href="../flowunsteady-run/">(5) Run Simulation</a></li><li><input class="collapse-toggle" id="menuitem-7-6" type="checkbox"/><label class="tocitem" for="menuitem-7-6"><span class="docs-label">(6) Viz and Postprocessing</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../flowunsteady-postprocessing-fdom/">Fluid Domain</a></li><li><a class="tocitem" href="../flowunsteady-postprocessing-noise/">Aeroacoustic Noise</a></li><li><a class="tocitem" href="../flowunsteady-postprocessing-misc/">Miscellaneous</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-7-7" type="checkbox"/><label class="tocitem" for="menuitem-7-7"><span class="docs-label">Extras</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><input class="collapse-toggle" id="menuitem-7-7-1" type="checkbox"/><label class="tocitem" for="menuitem-7-7-1"><span class="docs-label">FLOWVPM</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../flowvpm-particle/">Particle Field</a></li><li><a class="tocitem" href="../flowvpm-uj/">UJ Scheme</a></li><li><a class="tocitem" href="../flowvpm-viscous/">Viscous Scheme</a></li><li><a class="tocitem" href="../flowvpm-relaxation/">Relaxation Scheme</a></li><li><a class="tocitem" href="../flowvpm-sfs/">SFS Scheme</a></li><li><a class="tocitem" href="../flowvpm-time/">Time Integration</a></li><li><a class="tocitem" href="../flowvpm-utils/">Utilities</a></li></ul></li></ul></li></ul></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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API Guide</a></li><li><a class="is-disabled">(1) Vehicle Definition</a></li><li class="is-active"><a href>Importing OpenVSP geometry</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Importing OpenVSP geometry</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/byuflowlab/FLOWUnsteady/blob/master/docs/src/api/flowunsteady-openvsp.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="openvsp_import"><a class="docs-heading-anchor" href="#openvsp_import">Importing OpenVSP geometry</a><a id="openvsp_import-1"></a><a class="docs-heading-anchor-permalink" href="#openvsp_import" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="FLOWUnsteady.read_degengeom" href="#FLOWUnsteady.read_degengeom"><code>FLOWUnsteady.read_degengeom</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">`read_degengeom(filename::String)`</code></pre><p>Read all geometry components from a DegenGeom file written out by OpenVSP</p><p><strong>Arguments</strong></p><ul><li><code>filename::String</code>: DegenGeom filename</li></ul><p><strong>Returns</strong></p><ul><li><code>comp</code>: Vector of <code>vsp.VSPComponent</code> objects</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byuflowlab/FLOWUnsteady/blob/d38b0d7c7dd8cb5355af4471247ab9ad2a008da0/src/FLOWUnsteady_openvsp.jl#L10-L20">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FLOWUnsteady.import_vsp" href="#FLOWUnsteady.import_vsp"><code>FLOWUnsteady.import_vsp</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">`import_vsp(comp::vsp.VSPComponent; geomType::String=&quot;&quot;,
+            flip_y::Bool=false, transpose_grid::Bool=false)`</code></pre><p>Imports properties from OpenVSP component to FLOWUnsteady objects. Importing prop and duct geometries are under development.</p><p><strong>Arguments</strong></p><ul><li><code>comp::vsp.VSPComponent</code>: Single <code>vsp.VSPComponent</code> object</li><li><code>geomType::String</code> : Geometry type may be one of - <code>wing</code>, <code>fuselage</code>, <code>prop</code>, <code>duct</code></li><li><code>symmetric::Bool</code> : Creates a symmetric wing using the semi-span coordinates</li><li><code>flip_y::Bool</code> : Flip y-coordinates about longitudinal plane. Useful for symmetric geometry</li><li><code>transpose_grid::Bool</code> : Swap ordering of grid points</li></ul><p><strong>Returns</strong></p><ul><li><code>geom</code>: FLOWUnsteady geometry</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byuflowlab/FLOWUnsteady/blob/d38b0d7c7dd8cb5355af4471247ab9ad2a008da0/src/FLOWUnsteady_openvsp.jl#L26-L41">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../flowunsteady-vehicle-asm/">« Actuator surface model</a><a class="docs-footer-nextpage" href="../flowunsteady-maneuver/">(2) Maneuver Definition »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Thursday 16 November 2023 13:21">Thursday 16 November 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>