Skip to content

Commit

Permalink
insert docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
BTV25 committed Jan 13, 2025
1 parent 2396699 commit a703fcb
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/src/library.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ steady_analysis
steady_analysis!
unsteady_analysis
unsteady_analysis!
nonlinear_analysis!
```

### Near Field Forces and Moments
Expand Down
2 changes: 1 addition & 1 deletion src/VortexLattice.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/nonlinear.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit a703fcb

Please sign in to comment.