From a703fcb9bdfa4537d6f40ed03642d4fb03830dc5 Mon Sep 17 00:00:00 2001 From: BTV25 <70768698+BTV25@users.noreply.github.com> Date: Mon, 13 Jan 2025 16:05:11 -0700 Subject: [PATCH] insert docstring --- docs/src/library.md | 1 + src/VortexLattice.jl | 2 +- src/nonlinear.jl | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/src/library.md b/docs/src/library.md index d4cf5c6..4f8dd2d 100644 --- a/docs/src/library.md +++ b/docs/src/library.md @@ -58,6 +58,7 @@ steady_analysis steady_analysis! unsteady_analysis unsteady_analysis! +nonlinear_analysis! ``` ### Near Field Forces and Moments diff --git a/src/VortexLattice.jl b/src/VortexLattice.jl index 70bdd30..54298f7 100644 --- a/src/VortexLattice.jl +++ b/src/VortexLattice.jl @@ -12,7 +12,7 @@ using DelimitedFiles const RHO = 1.0 include("nonlinear.jl") -export SectionProperties, grid_to_sections#, nonlinear_analysis! +export SectionProperties, grid_to_sections, nonlinear_analysis! include("rotors.jl") export generate_rotor diff --git a/src/nonlinear.jl b/src/nonlinear.jl index 542527a..ed3d5db 100644 --- a/src/nonlinear.jl +++ b/src/nonlinear.jl @@ -78,12 +78,12 @@ function redefine_gamma_index!(sections) end end + """ nonlinear_analysis!(system) Perform a nonlinear analysis on the system. This function will calculate the angle of attack, lift, and drag coefficients for each section in the system. """ - function nonlinear_analysis!(system) vel = zeros(2) n_hat = zeros(3)