Deployed 9e26253 with MkDocs version: 1.1.2

api/flowunsteady-postprocessing-misc/index.html

@@ -10,10 +10,10 @@
                         cyl_axial_dir   = nothing,  # Calculate cylindrical statistics if given an axial axis (vector)
                         # OUTPUT OPTIONS
                         prompt=true, debug=false,
-                        verbose=true, v_lvl=0)</code></pre><p>Calculate statistics of the simulation VTK outputs over a given range of time steps given by <code>nums</code>. Use this to calculate, for instance, the mean load distribution and fluctuations on wings and rotors.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byuflowlab/FLOWUnsteady/blob/ef7f39c1b15abfcd02bd815065eaa102744cf2ce/src/FLOWUnsteady_postprocessing.jl#L11-L24">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FLOWUnsteady.postprocess_bladeloading" href="#FLOWUnsteady.postprocess_bladeloading"><code>FLOWUnsteady.postprocess_bladeloading</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">postprocess_bladeloading(read_path;
+                        verbose=true, v_lvl=0)</code></pre><p>Calculate statistics of the simulation VTK outputs over a given range of time steps given by <code>nums</code>. Use this to calculate, for instance, the mean load distribution and fluctuations on wings and rotors.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byuflowlab/FLOWUnsteady/blob/9e26253256bc52f9ac3a1617688b4218e17bd898/src/FLOWUnsteady_postprocessing.jl#L11-L24">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FLOWUnsteady.postprocess_bladeloading" href="#FLOWUnsteady.postprocess_bladeloading"><code>FLOWUnsteady.postprocess_bladeloading</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">postprocess_bladeloading(read_path;
                             O           = zeros(3),     # Rotor center
                             rotor_axis  = [-1, 0, 0],   # Rotor centerline axis
                             Ftot_axis   = nothing,      # Use a different centerline axis for forces if given
                             filename    = &quot;singlerotor_Rotor_Blade1_vlm-statistics.vtk&quot;, # File name
                             fieldsuff   = &quot;-mean&quot;       # Suffix of fields &quot;Gamma&quot; and &quot;Ftot&quot;, if any
-                            )</code></pre><p>Read a blade VTK file <code>filename</code> under directory <code>read_path</code> and returns the circulation and force components of the load distribution along the blade.</p><p>Return: <code>rs, Gamma, Np, Tp, Rp, Zhat, Rhat, That, Ftot</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byuflowlab/FLOWUnsteady/blob/ef7f39c1b15abfcd02bd815065eaa102744cf2ce/src/FLOWUnsteady_postprocessing.jl#L111-L124">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../flowunsteady-postprocessing-noise/">« Aeroacoustic Noise</a><a class="docs-footer-nextpage" href="../flowvpm-particle/">Particle Field »</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.25 on <span class="colophon-date" title="Tuesday 16 April 2024 17:52">Tuesday 16 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+                            )</code></pre><p>Read a blade VTK file <code>filename</code> under directory <code>read_path</code> and returns the circulation and force components of the load distribution along the blade.</p><p>Return: <code>rs, Gamma, Np, Tp, Rp, Zhat, Rhat, That, Ftot</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byuflowlab/FLOWUnsteady/blob/9e26253256bc52f9ac3a1617688b4218e17bd898/src/FLOWUnsteady_postprocessing.jl#L111-L124">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../flowunsteady-postprocessing-noise/">« Aeroacoustic Noise</a><a class="docs-footer-nextpage" href="../flowvpm-particle/">Particle Field »</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.25 on <span class="colophon-date" title="Monday 16 December 2024 11:02">Monday 16 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

api/flowunsteady-postprocessing-noise/index.html

@@ -48,7 +48,7 @@
     debuglvl    = 1,                # PSU-WOPWOP debug level
     observerf_name = "observergrid",# .xyz file with observer grid
     case_name   = "runcase",        # Name of case to create and run
-)</code></pre><p><strong>NOTE:</strong> This function will call the PSU-WOPWOP binary indicated through <code>wopwopbin</code>. This binary is not included with FLOWUnsteady and must be provided by the user. This method has been tested on PSU-WOPWOP v3.4.2.</p><p><strong>NOTE 2:</strong> Make sure that the simulation was run with <code>nsteps_save=1</code>, otherwise the time in PSU-WOPWOP will get messed up.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byuflowlab/FLOWUnsteady/blob/ef7f39c1b15abfcd02bd815065eaa102744cf2ce/src/FLOWUnsteady_noise_wopwop.jl#L11-L72">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FLOWUnsteady.run_noise_bpm" href="#FLOWUnsteady.run_noise_bpm"><code>FLOWUnsteady.run_noise_bpm</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Calculates broadband rotor noise through the Brooks, Pope, and Marcolini method using the <a href="https://github.com/byuflowlab/BPM.jl">BPM.jl package</a>.</p><p>This writes the results to a file in the same format than PSU-WOPWOP, which can be read afterwards with <code>FLOWNoise.readwopwopoutput()</code>. It writes three files: SPL (non-weighted), A-weighted SPL, and OASPL.</p><p>This method assumes steady conditions and that all rotors have the same RPM.</p><pre><code class="language-julia hljs">function run_noise_bpm(
+)</code></pre><p><strong>NOTE:</strong> This function will call the PSU-WOPWOP binary indicated through <code>wopwopbin</code>. This binary is not included with FLOWUnsteady and must be provided by the user. This method has been tested on PSU-WOPWOP v3.4.2.</p><p><strong>NOTE 2:</strong> Make sure that the simulation was run with <code>nsteps_save=1</code>, otherwise the time in PSU-WOPWOP will get messed up.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byuflowlab/FLOWUnsteady/blob/9e26253256bc52f9ac3a1617688b4218e17bd898/src/FLOWUnsteady_noise_wopwop.jl#L11-L72">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FLOWUnsteady.run_noise_bpm" href="#FLOWUnsteady.run_noise_bpm"><code>FLOWUnsteady.run_noise_bpm</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Calculates broadband rotor noise through the Brooks, Pope, and Marcolini method using the <a href="https://github.com/byuflowlab/BPM.jl">BPM.jl package</a>.</p><p>This writes the results to a file in the same format than PSU-WOPWOP, which can be read afterwards with <code>FLOWNoise.readwopwopoutput()</code>. It writes three files: SPL (non-weighted), A-weighted SPL, and OASPL.</p><p>This method assumes steady conditions and that all rotors have the same RPM.</p><pre><code class="language-julia hljs">function run_noise_bpm(
     rotors::Array{vlm.Rotor, 1},    # Rotors
     RPM::Real,                      # RPM of rotors
     Vinf::Function,                 # Freestream
@@ -75,4 +75,4 @@
     prompt      = true,             # Whether to prompt the user
     verbose     = true,             # Whether to verbose
     v_lvl       = 0,                # Indentation level when printing verbose
-)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byuflowlab/FLOWUnsteady/blob/ef7f39c1b15abfcd02bd815065eaa102744cf2ce/src/FLOWUnsteady_noise_bpm.jl#L11-L51">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../flowunsteady-postprocessing-fdom/">« Fluid Domain</a><a class="docs-footer-nextpage" href="../flowunsteady-postprocessing-misc/">Miscellaneous »</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.25 on <span class="colophon-date" title="Tuesday 16 April 2024 17:52">Tuesday 16 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byuflowlab/FLOWUnsteady/blob/9e26253256bc52f9ac3a1617688b4218e17bd898/src/FLOWUnsteady_noise_bpm.jl#L11-L51">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../flowunsteady-postprocessing-fdom/">« Fluid Domain</a><a class="docs-footer-nextpage" href="../flowunsteady-postprocessing-misc/">Miscellaneous »</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.25 on <span class="colophon-date" title="Monday 16 December 2024 11:02">Monday 16 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>