Merge pull request #24 from byuflowlab/vortex

Vortex

.github/workflows/CI.yml

@@ -18,8 +18,8 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.6'
-          - 'nightly'
+          - '1.7'
+          # - 'nightly'
         os:
           - ubuntu-latest
         arch:
@@ -54,6 +54,6 @@ jobs:
       - run: |
           julia --project=docs -e '
             using Documenter: DocMeta, doctest
-            using DuctTAPE
-            DocMeta.setdocmeta!(DuctTAPE, :DocTestSetup, :(using DuctTAPE); recursive=true)
-            doctest(DuctTAPE)'
+            using DuctAPE
+            DocMeta.setdocmeta!(DuctAPE, :DocTestSetup, :(using DuctAPE); recursive=true)
+            doctest(DuctAPE)'

.gitignore

@@ -7,16 +7,17 @@
 *.key
 *.idraw
 /*.pdf
-examples/*.pdf
-examples/rotor_only/*.pdf
-examples/dfdc_comp/*.pdf
-examples/debug_coupling/*.pdf
-examples/dfdc_partial/outputs/*.pdf
-examples/dfdc_partial/outputs/*.png
-examples/dfdc_partial/outputs/*.vtk
-examples/*.png
+dev_debug_archive/*.pdf
+dev_debug_archive/rotor_only/*.pdf
+dev_debug_archive/dfdc_comp/*.pdf
+dev_debug_archive/debug_coupling/*.pdf
+dev_debug_archive/dfdc_partial/outputs/*.pdf
+dev_debug_archive/dfdc_partial/outputs/*.png
+dev_debug_archive/dfdc_partial/outputs/*.vtk
+dev_debug_archive/*.png
 test/manual_tests/*/*.pdf
 test/manual_tests/*/*.png
+test/figures/*.gif
 /*.png
 
 # julia
@@ -31,5 +32,5 @@ _*
 Manifest.toml
 
 # dfdc
-/examples/*/fort*
+/dev_debug_archive/*/fort*
 

Project.toml

@@ -1,4 +1,4 @@
-name = "DuctTAPE"
+name = "DuctAPE"
 uuid = "ad8e49fd-fab7-444e-af4a-0daba3b8bf11"
 authors = ["Judd Mehr"]
 version = "0.1.0"
@@ -14,7 +14,9 @@ LineSearches = "d3d80556-e9d4-5f37-9878-2ab0fcc64255"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 NLsolve = "2774e3e8-f4cf-5e23-947b-6d7e65073b56"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+QuadGK = "1fd47b50-473d-5c70-9696-f719f8f3bcdc"
 SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
+StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
@@ -28,5 +30,5 @@ IterativeSolvers = "0.9"
 LineSearches = "7"
 NLsolve = "4"
 SpecialFunctions = "2"
-Statistics = "1"
-julia = "1.6"
+julia = "1.7"
+

README.md

@@ -1,15 +1,9 @@
-# DuctTAPE.jl [[Duct](#)ed [T](#)wo-dimensional ([A](#)xisymmetric) [P](#)ropulsor [E](#)valuation]
+# DuctAPE.jl [[Duct](#)ed [A](#)xisymmetric [P](#)ropulsor [E](#)valuation]
 
-<!-- [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://flow.byu.edu/DuctTAPE.jl/stable) -->
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://flow.byu.edu/DuctTAPE.jl/dev)
-[![Build Status](https://github.com/byuflowlab/DuctTAPE.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/byuflowlab/DuctTAPE.jl/actions/workflows/CI.yml?query=branch%3Amain)
+<!-- [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://flow.byu.edu/DuctAPE.jl/stable) -->
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://flow.byu.edu/DuctAPE.jl/dev)
+[![Build Status](https://github.com/byuflowlab/DuctAPE.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/byuflowlab/DuctAPE.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
 
-DuctTAPE is a code for the aerodynamic evaluation of axisymmetric ducted propulsors designed for incompressible *(low Mach) applications.
-
-
-## Warning: "Unregistered Dependencies"
-Currently, FLOWFoil is an unregistered dependency of DuctTAPE.
-For this reason, all automated github testing fails.
-
-In addition, in order to allow the documentation to be automatically deployed, we commented out the FLOWFoil line in both `src/DuctTAPE.jl` and `Project.toml`.  In order for DuctTAPE to function, those line will need to be uncommented by the user.
+DuctAPE is a code for the aerodynamic evaluation of axisymmetric ducted propulsors designed for incompressible (low mach) applications.
+It is strongly influenced by the underlying [theory](https://web.mit.edu/drela/Public/web/dfdc/DFDCtheory12-31.pdf) of Ducted Fan Design Code [(DFDC)](https://web.mit.edu/drela/Public/web/dfdc/), utilizing a linear axisymmetric vortex panel method for duct and center body, blade element lifting line rotor representation, and psuedo wake-screw wake model axisymmetrically smeared onto an elliptic grid for efficient computation.

examples/better_vels/.ipynb_checkpoints/induced_velocity_options-checkpoint.ipynb → dev_debug_archive/better_vels/.ipynb_checkpoints/induced_velocity_options-checkpoint.ipynb

@@ -116,7 +116,7 @@
    "source": [
     "### --- Vortex Rings --- ###\n",
     "# - Unit Induced Axial Velocity - #\n",
-    "function vx_vortex(origin, field)\n",
+    "function vz_vortex(origin, field)\n",
     "    \n",
     "    # get the relative geometry\n",
     "    (; xm, rm, xn, rn, xi, rho, r1sq, r2sq, k2, K, E) = relative_geometry(origin, field)\n",
@@ -181,7 +181,7 @@
     "# test that the functions run\n",
     "origin = [0.0; 1.0]\n",
     "field = [2.0; 2.0]\n",
-    "vx = vx_vortex(origin, field)\n",
+    "vx = vz_vortex(origin, field)\n",
     "vr = vr_vortex(origin, field);"
    ]
   },
@@ -709,7 +709,7 @@
     "vr = zeros(N)\n",
     "for i in 1:N\n",
     "    field = [fx[i]; origin[2]]\n",
-    "    vx[i] = vx_vortex(origin, field)\n",
+    "    vx[i] = vz_vortex(origin, field)\n",
     "    vr[i] = vr_vortex(origin, field)\n",
     "end\n",
     "\n",
@@ -1281,7 +1281,7 @@
     "vr = zeros(N)\n",
     "for i in 1:N\n",
     "    field = [origin[1]; fr[i]]\n",
-    "    vx[i] = vx_vortex(origin, field)\n",
+    "    vx[i] = vz_vortex(origin, field)\n",
     "    vr[i] = vr_vortex(origin, field)\n",
     "end\n",
     "\n",