Skip to content

Commit a4e0ed7

Browse files
committed
Update docs
1 parent 760ddf9 commit a4e0ed7

File tree

5 files changed

+7
-5
lines changed

5 files changed

+7
-5
lines changed

docs/src/functions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ add_section!
1111
set_va!
1212
solve
1313
solve!
14+
init!(body_aero::BodyAerodynamics)
15+
linearize
1416
```
1517

1618
## Main Plotting Functions

docs/src/private_functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ CurrentModule = VortexStepMethod
77
calculate_AIC_matrices!
88
update_panel_properties!
99
calculate_inertia_tensor
10-
init!
10+
group_deform!
1111
```

src/VortexStepMethod.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ using DifferentiationInterface
2222
import SciMLBase: successful_retcode
2323

2424
# Export public interface
25-
export Wing, Section, RamAirWing
25+
export Wing, Section, RamAirWing, init!
2626
export BodyAerodynamics
2727
export Solver, solve, solve_base!, solve!, VSMSolution, linearize
2828
export calculate_results

src/body_aerodynamics.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ function Base.setproperty!(obj::BodyAerodynamics, sym::Symbol, val)
114114
end
115115

116116
"""
117-
init!(body_aero::BodyAerodynamics)
117+
init!(body_aero::BodyAerodynamics; init_aero, va, omega)
118118
119119
Initialize a BodyAerodynamics struct in-place by setting up panels and coefficients.
120120

src/solver.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -647,8 +647,8 @@ Compute the Jacobian matrix for a ram air wing around an operating point using a
647647
# Keyword Arguments
648648
- `theta_idxs`: Indices of twist angles in input vector (default: 1:4)
649649
- `delta_idxs`: Indices of trailing edge deflection angles (default: nothing)
650-
- `va_idxs`: Indices of velocity components [vx, vy, vz] (default: nothing)
651-
- `omega_idxs`: Indices of angular velocity components [ωx, ωy, ωz] (default: nothing)
650+
- `va_idxs`: Indices of velocity components `[vx, vy, vz]` (default: nothing)
651+
- `omega_idxs`: Indices of angular velocity components `[ωx, ωy, ωz]` (default: nothing)
652652
- `kwargs...`: Additional arguments passed to the `solve!` function
653653
654654
# Returns

0 commit comments

Comments
 (0)