Skip to content

Commit

Permalink
build based on caeccce
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Dec 7, 2023
1 parent b867a97 commit b640716
Show file tree
Hide file tree
Showing 28 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-06T21:59:35","documenter_version":"1.2.1"}}
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-07T04:22:00","documenter_version":"1.2.1"}}
2 changes: 1 addition & 1 deletion dev/aero/drag/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -198,4 +198,4 @@
co, cdf, cdp,
Reco, Reref,
aRexp, kSuns, fCDcen)</code></pre><p>Computes wing or tail surface profile CD from pre-computed chord quantities and corrections. Called by <a href="#TASOPT.aerodynamics.cdsum!-NTuple{5, Any}"><code>cdsum!</code></a> if <code>icdfun</code> flag set to 0.</p><div class="admonition is-compat"><header class="admonition-header">Future Changes</header><div class="admonition-body"><p>This function may be renamed for clarity of use.</p></div></div><details class="admonition is-details"><summary class="admonition-header">🔃 Inputs and Outputs</summary><div class="admonition-body"><p><strong>Inputs:</strong></p><ul><li><code>S::Float64</code>: reference area.</li><li><code>b::Float64</code>: span.</li><li><code>bs::Float64</code>: outer panel break span.</li><li><code>bo::Float64</code>: wing-root (fuselage) span.</li><li><code>λt::Float64</code>: outer-panel taper ratio <span>$ct/co$</span>.</li><li><code>λs::Float64</code>: inner-panel taper ratio <span>$cs/co$</span>.</li><li><code>sweep::Float64</code>: wing sweep, degrees.</li><li><code>co::Float64</code>: wing root chord.</li><li><code>cdf::Float64</code>: friction profile cd.</li><li><code>cdp::Float64</code>: pressure profile cd.</li><li><code>Reco::Float64</code>: Reynolds number for co.</li><li><code>Reref::Float64</code>: reference Reynolds number for cd scaling.</li><li><code>aRexp::Float64</code>: Re-scaling exponent.</li><li><code>kSuns::Float64</code>: shock-unsweep area constant.</li><li><code>fCDcen::Float64</code> : related to fraction of wing BLI (see Eqns. 619 - 621).</li></ul><p><strong>Outputs:</strong></p><ul><li><code>CDsurf</code>: overall profile CD.</li><li><code>CDover</code>: fuselage added CD due to lift carryover.</li></ul></div></details><p>See Sections 2.14.3 and 3.8.3 of the <a href="../../misc/dreladocs/#dreladocs">TASOPT Technical Desc</a>.</p></div></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="TASOPT.aerodynamics.airtable-Tuple{Any}" href="#TASOPT.aerodynamics.airtable-Tuple{Any}"><code>TASOPT.aerodynamics.airtable</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">airtable(fname)</code></pre><p>Reads airfoil file and outputs the matrix and splines as an <code>airfoil</code>.</p><p>The airfoil data is stored as a function of three variables, typically Mach number <span>$\mathrm{Ma}$</span>, lift coefficient <span>$c_l$</span>, and thickness to chord ratio <span>$\tau$</span>.</p><pre><code class="nohighlight hljs">cdf(Ma, cl, τ), cdp(Ma, cl, τ), cm(Ma, cl, τ)</code></pre><details class="admonition is-details"><summary class="admonition-header">🔃 Inputs and Outputs</summary><div class="admonition-body"><p><strong>Inputs:</strong></p><ul><li><code>fname::String</code>: Path to file.</li></ul><p><strong>Outputs:</strong></p><ul><li><code>airf::TASOPT.aerodynamics.airfoil</code>: struct with airfoil performance characteristics.</li></ul></div></details><div class="admonition is-compat"><header class="admonition-header">Future Changes</header><div class="admonition-body"><p>Deprecates <code>airtable</code> in <code>airtable.jl</code>. The current file will be renamed.</p></div></div></div></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="TASOPT.aerodynamics.airfun-Tuple{Any, Any, Any, TASOPT.aerodynamics.airfoil}" href="#TASOPT.aerodynamics.airfun-Tuple{Any, Any, Any, TASOPT.aerodynamics.airfoil}"><code>TASOPT.aerodynamics.airfun</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">airfun(cl, τ, Mach, air::airfoil)</code></pre><p>Looks up airfoil performance data at specified conditions, as precomputed and found in <code>./src/air/C.air</code>.</p><details class="admonition is-details"><summary class="admonition-header">🔃 Inputs and Outputs</summary><div class="admonition-body"><p><strong>Inputs:</strong> </p><ul><li><code>cl::Float64</code>: Airfoil section lift coefficient.</li><li><code>τ::Float64</code>: Airfoil section thickness-to-chord ratio.</li><li><code>Mach::Float64</code>: Mach number.</li><li><code>air::TASOPT.aerodynamics.airfoil</code>: <code>airfoil</code> structure with performance data.</li></ul><p><strong>Outputs:</strong></p><ul><li><code>cdf::Float64</code>: Airfoil section skin friction drag.</li><li><code>cdp::Float64</code>: Airfoil section pressure drag.</li><li><code>cdw::Float64</code>: Airfoil section wave drag (unused and assumed 0 here; placeholder left for future implementation).</li><li><code>cm::Float64</code>: Airfoil section pitching moment.</li></ul></div></details></div></section></article><hr/><h2 id="Total-drag-calculation"><a class="docs-heading-anchor" href="#Total-drag-calculation">Total drag calculation</a><a id="Total-drag-calculation-1"></a><a class="docs-heading-anchor-permalink" href="#Total-drag-calculation" 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="TASOPT.aerodynamics.cdsum!-NTuple{5, Any}" href="#TASOPT.aerodynamics.cdsum!-NTuple{5, Any}"><code>TASOPT.aerodynamics.cdsum!</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">cdsum!(pari,parg,para,pare,icdfun)</code></pre><p>Calculates aircraft <code>CD</code> components for operating point, ipoint. If <code>icdfun=1</code>, computes wing <code>cdf</code>,<code>cdp</code> from airfoil database # <code>iairf</code>, otherwise uses default values in para array. Called by <code>mission!</code>, <code>wsize</code>, <code>takeoff!</code>, and <code>odperf!</code>.</p><p>The total drag is computed by</p><p class="math-container">\[C_{D} = C_{D, i} + C_{D,fuse} + C_{D,wing} + C_{D,over} + C_{D,htail} + C_{D,vtail} + C_{D,strut} + C_{D,nace} + \Delta C_{D,BLI,f} + \Delta C_{D,BLI,w}\]</p><p>where:</p><ul><li><span>$C_{D,i}$</span> (<code>CDi</code>) is the total induced drag including the wing and tail,</li><li><span>$C_{D,fuse}$</span> (<code>CDfuse</code>) is the fuselage profile drage computed by solving a boundary layer integral equation,</li><li><span>$C_{D,wing}$</span> (<code>CDwing</code>) is the wing profile drag (viscous + pressure) computed using airfoil data obtained from CFD,</li><li><span>$C_{D,over}$</span> (<code>CDover</code>) is the fuselage added CD due to lift carryover,</li><li><span>$C_{D,htail}$</span> (<code>CDhtail</code>) is the horizontal tail profile drag computed in a similar manner with <code>CDwing</code>,</li><li><span>$C_{D,vtail}$</span> (<code>CDvtail</code>) is the vertical tail profile drag computed in a similar manner with <code>CDwing</code>,</li><li><span>$C_{D,strut}$</span> (<code>CDstrut</code>) is the struct profile drag, </li><li><span>$C_{D,nace}$</span> (<code>CDnace</code>) is the nacelle profile drag,</li><li><span>$\Delta C_{D,BLI,f}$</span> (<code>dCDBLIf</code>) is related to the boundary layer ingestion on the fuselage,</li><li>and <span>$\Delta C_{D,BLI,w}$</span> (<code>dCDBLIw</code>) is related to the boundary layer ingestion on the wing.</li></ul><details class="admonition is-details"><summary class="admonition-header">🔃 Inputs and Outputs</summary><div class="admonition-body"><p><strong>Inputs:</strong></p><ul><li><code>pari::AbstractVector{Int64}</code>: Vector of <code>aircraft</code> model integer/flag parameters.</li><li><code>parg::AbstractArray{Float64}</code>: Vector of <code>aircraft</code> model geometry parameters.</li><li><code>para::AbstractArray{Float64}</code>: Vector of <code>aircraft</code> model aerodynamic parameters.</li><li><code>pare::AbstractArray{Float64}</code>: Vector of <code>aircraft</code> model engine parameters.</li><li><code>icdfun::Integer</code>: Flag if drag should be computed (=1) or if para values should be used (=0).</li></ul><p><strong>Outputs:</strong></p><ul><li>No explicit outputs. Computed drag values are saved to <code>para</code> of <code>aircraft</code> model.</li></ul></div></details><p>See Section 2.14 of the <a href="../../misc/dreladocs/#dreladocs">TASOPT Technical Desc</a>. See also <a href="#TASOPT.aerodynamics.trefftz1-NTuple{32, Any}"><code>trefftz1</code></a>, <a href="#TASOPT.aerodynamics.fusebl!-NTuple{4, Any}"><code>fusebl!</code></a>, <a href="#TASOPT.aerodynamics.surfcd2-NTuple{25, Any}"><code>surfcd2</code></a>, <a href="#TASOPT.aerodynamics.surfcd-NTuple{15, Any}"><code>surfcd</code></a>, <a href="#TASOPT.aerodynamics.cfturb"><code>cfturb</code></a>, and <code>cditrp</code>.</p><div class="admonition is-compat"><header class="admonition-header">Future Changes</header><div class="admonition-body"><p>In an upcoming revision, an <code>aircraft</code> struct and auxiliary indices will be passed in lieu of pre-sliced <code>par</code> arrays.</p></div></div></div></section></article><hr/><h2 id="Other-utilities"><a class="docs-heading-anchor" href="#Other-utilities">Other utilities</a><a id="Other-utilities-1"></a><a class="docs-heading-anchor-permalink" href="#Other-utilities" 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="TASOPT.aerodynamics.cfturb" href="#TASOPT.aerodynamics.cfturb"><code>TASOPT.aerodynamics.cfturb</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs"> cfturb(Re)</code></pre><p>Returns the total <span>$C_f$</span> for turbulent flat plate (one side) as a function of <span>$\mathrm{Re}_l$</span></p><p class="math-container">\[C_{f, turb} = \frac{0.523}{(\log(0.06\mathrm{Re}))^2} \]</p></div></section></article><p>For example, the turbulent flat plate <span>$C_f$</span> for a <span>$Re$</span> of <span>$10e6$</span> can be calculated as follows:</p><pre><code class="language-julia hljs">Re = 10e6
cfturb(Re)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">0.002954557862895432</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../lift/">« Lift</a><a class="docs-footer-nextpage" href="../moment/">Pitching moment »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Wednesday 6 December 2023 21:59">Wednesday 6 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
cfturb(Re)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">0.002954557862895432</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../lift/">« Lift</a><a class="docs-footer-nextpage" href="../moment/">Pitching moment »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Thursday 7 December 2023 04:22">Thursday 7 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/aero/geometry/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@
S_{\rm ref} &amp;\!= (S)_{\rm wing}\\
{A\hspace{-0.5ex}R}_{\rm ref} &amp;\!= ({A\hspace{-0.5ex}R})_{\rm wing}\\
c_{\rm ref} &amp;\!= (c_{\rm ma})_{\rm wing}
\end{aligned}\]</p><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="TASOPT.aerodynamics.wingsc-NTuple{8, Any}" href="#TASOPT.aerodynamics.wingsc-NTuple{8, Any}"><code>TASOPT.aerodynamics.wingsc</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">wingsc(W, CL, qinf, AR, ηsi, bo, λt, λs)</code></pre><p>Sizes wing area, span, root chord from <code>q</code>, <code>CL</code>, <code>W</code>, <code>AR</code> at given point (taken as start-of-cruise in <code>wsize</code>).</p><details class="admonition is-details"><summary class="admonition-header">🔃 Inputs and Outputs</summary><div class="admonition-body"><p><strong>Inputs:</strong></p><ul><li><code>W::Float64</code>: Aircraft weight.</li><li><code>CL::Float64</code>: Lift coefficient.</li><li><code>qinf::Float64</code>: Freestream dynamic head.</li><li><code>AR::Float64</code>: Wing aspect ratio.</li><li><code>ηsi::Float64</code>: Span fraction of inner wing break (&quot;snag&quot;).</li><li><code>bo::Float64</code>: Wing center box width.</li><li><code>λt::Float64</code>: Outer or &quot;tip&quot; taper ratio of chord.</li><li><code>λs::Float64</code>: Inner or break/&quot;snag&quot; taper ratio of chord.</li></ul><p><strong>Outputs:</strong></p><ul><li><code>S::Float64</code>: Wing planform area (including fuselage carryover).</li><li><code>b::Float64</code>: Wing span.</li><li><code>bs::Float64</code>: Span of inner wing (break/&quot;snag&quot;).</li><li><code>co::Float64</code>: Chord at wing root, &quot;center.&quot;</li></ul></div></details><p>See Sections 2.5 and 3.4.1 of the <a href="../../misc/dreladocs/#dreladocs">TASOPT Technical Desc</a>.</p></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../examples/optimization/">« Multivariable optimization</a><a class="docs-footer-nextpage" href="../lift/">Lift »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Wednesday 6 December 2023 21:59">Wednesday 6 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
\end{aligned}\]</p><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="TASOPT.aerodynamics.wingsc-NTuple{8, Any}" href="#TASOPT.aerodynamics.wingsc-NTuple{8, Any}"><code>TASOPT.aerodynamics.wingsc</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">wingsc(W, CL, qinf, AR, ηsi, bo, λt, λs)</code></pre><p>Sizes wing area, span, root chord from <code>q</code>, <code>CL</code>, <code>W</code>, <code>AR</code> at given point (taken as start-of-cruise in <code>wsize</code>).</p><details class="admonition is-details"><summary class="admonition-header">🔃 Inputs and Outputs</summary><div class="admonition-body"><p><strong>Inputs:</strong></p><ul><li><code>W::Float64</code>: Aircraft weight.</li><li><code>CL::Float64</code>: Lift coefficient.</li><li><code>qinf::Float64</code>: Freestream dynamic head.</li><li><code>AR::Float64</code>: Wing aspect ratio.</li><li><code>ηsi::Float64</code>: Span fraction of inner wing break (&quot;snag&quot;).</li><li><code>bo::Float64</code>: Wing center box width.</li><li><code>λt::Float64</code>: Outer or &quot;tip&quot; taper ratio of chord.</li><li><code>λs::Float64</code>: Inner or break/&quot;snag&quot; taper ratio of chord.</li></ul><p><strong>Outputs:</strong></p><ul><li><code>S::Float64</code>: Wing planform area (including fuselage carryover).</li><li><code>b::Float64</code>: Wing span.</li><li><code>bs::Float64</code>: Span of inner wing (break/&quot;snag&quot;).</li><li><code>co::Float64</code>: Chord at wing root, &quot;center.&quot;</li></ul></div></details><p>See Sections 2.5 and 3.4.1 of the <a href="../../misc/dreladocs/#dreladocs">TASOPT Technical Desc</a>.</p></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../examples/optimization/">« Multivariable optimization</a><a class="docs-footer-nextpage" href="../lift/">Lift »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Thursday 7 December 2023 04:22">Thursday 7 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit b640716

Please sign in to comment.